Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
deploymentShapes
List Deployment Shapes
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapes \
  --header 'Authorization: Bearer <token>'
{
  "deploymentShapes": [
    {
      "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,
      "enableSessionAffinity": true,
      "numLoraDeviceCached": 123,
      "presetType": "PRESET_TYPE_UNSPECIFIED"
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

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

Query Parameters

​
pageSize
integer<int32>

The maximum number of deployments 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 ListDeploymentShapes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeploymentShapes must match the call that provided the page token.

​
filter
string

Only deployment 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.

​
targetModel
string

Target model that the returned deployment shapes should be compatible with.

Response

200 - application/json

A successful response.

​
deploymentShapes
A deployment shape is a set of parameters that define the shape of a deployment. Deployments are created from a deployment shape. Next ID: 34 · object[]
​
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 shapes.