List Deployment Shapes Versions

GET

accounts

{account_id}

deploymentShapes

{deployment_shape_id}

versions

List Deployment Shapes Versions

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

import requests

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

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', 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",
  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"

	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")
  .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")

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

{
  "deploymentShapeVersions": [
    {
      "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"
      ]
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

Use this endpoint to query available deployment shape versions for a given model. Use - as a wildcard for both account_id and deployment_shape_id to search across all accounts and shapes. To find which shapes work with a model — with the compatibility rules applied server-side — use Match Deployment Shape Versions instead. This endpoint is for listing versions of shapes you already know, for example to check which exact model version each validated version binds.

Example: List shapes for a model

To list validated deployment shapes for a specific model, use the filter parameter with snapshot.base_model and latest_validated=true:

curl -s "https://api.fireworks.ai/v1/accounts/-/deploymentShapes/-/versions?filter=snapshot.base_model%3D%22accounts%2Ffireworks%2Fmodels%2Fgpt-oss-120b%22%20AND%20latest_validated%3Dtrue&order_by=create_time%20desc" \
  -H "Authorization: Bearer $FIREWORKS_API_KEY" | jq .

Filter syntax

The filter parameter uses AIP-160 filtering. Common patterns:

Filter	Description
`snapshot.base_model="accounts/fireworks/models/MODEL_NAME"`	Filter by base model
`latest_validated=true`	Only return the latest validated version of each shape

Combine multiple conditions with AND:

snapshot.base_model="accounts/fireworks/models/MODEL_NAME" AND latest_validated=true

Remember to URL-encode the filter value when using curl directly. = becomes %3D, " becomes %22, and / becomes %2F.

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

Query Parameters

pageSize

integer<int32>

The maximum number of deployment shape versions to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageToken

string

A page token, received from a previous ListDeploymentShapeVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeploymentShapeVersions must match the call that provided the page token.

filter

string

Only deployment shape versions satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.

orderBy

string

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "create_time".

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.

deploymentShapeVersions

A deployment shape version is a specific version of a deployment shape. Versions are immutable, only created on updates and deleted when the deployment shape is deleted. · object[]

Show child attributes

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer<int32>

The total number of deployment shape versions.

⌘I

List Deployment Shapes Versions

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

import requests

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

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', 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",
  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"

	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")
  .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")

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

{
  "deploymentShapeVersions": [
    {
      "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"
      ]
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}