Get Deployment Shape Version - Fireworks AI Docs

GET

accounts

{account_id}

deploymentShapes

{deployment_shape_id}

versions

{version_id}

Get Deployment Shape Version

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "snapshot": {
    "baseModel": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "modelType": "<string>",
    "parameterCount": "<string>",
    "acceleratorCount": 123,
    "acceleratorType": "ACCELERATOR_TYPE_UNSPECIFIED",
    "precision": "PRECISION_UNSPECIFIED",
    "disableDeploymentSizeValidation": true,
    "enableAddons": true,
    "draftTokenCount": 123,
    "draftModel": "<string>",
    "ngramSpeculationLength": 123,
    "disableSpeculativeDecoding": true,
    "enableSessionAffinity": true,
    "numLoraDeviceCached": 123,
    "maxContextLength": 123,
    "presetType": "PRESET_TYPE_UNSPECIFIED"
  },
  "validated": true,
  "public": true,
  "latestValidated": true,
  "capabilities": [
    "CAPABILITY_UNSPECIFIED"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

deployment_shape_id

string

required

The Deployment Shape Id

version_id

string

required

The Version Id

Query Parameters

readMask

string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

name

string

read-only

createTime

string<date-time>

read-only

The creation time of the deployment shape version. Lists will be ordered by this field.

snapshot

A deployment shape is a set of parameters that define the shape of a deployment. Deployments are created from a deployment shape. · object

read-only

Full snapshot of the Deployment Shape at this version.

Show child attributes

validated

boolean

If true, this version has been validated.

public

boolean

If true, this version will be publicly readable.

latestValidated

boolean

read-only

If true, this version is the latest validated version. Only one version of the shape can be the latest validated version.

capabilities

enum<string>[]

The capabilities supported by this deployment shape version.

A capability that a deployment shape version supports.

Available options:

CAPABILITY_UNSPECIFIED,

MULTI_LORA

⌘I

Get Deployment Shape Version

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "snapshot": {
    "baseModel": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "modelType": "<string>",
    "parameterCount": "<string>",
    "acceleratorCount": 123,
    "acceleratorType": "ACCELERATOR_TYPE_UNSPECIFIED",
    "precision": "PRECISION_UNSPECIFIED",
    "disableDeploymentSizeValidation": true,
    "enableAddons": true,
    "draftTokenCount": 123,
    "draftModel": "<string>",
    "ngramSpeculationLength": 123,
    "disableSpeculativeDecoding": true,
    "enableSessionAffinity": true,
    "numLoraDeviceCached": 123,
    "maxContextLength": 123,
    "presetType": "PRESET_TYPE_UNSPECIFIED"
  },
  "validated": true,
  "public": true,
  "latestValidated": true,
  "capabilities": [
    "CAPABILITY_UNSPECIFIED"
  ]
}