GET
https://api.fireworks.ai
/
v1
/
accounts
/
{account_id}
/
deployments
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deployments \
  --header 'Authorization: Bearer <token>'
{
  "deployments": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "expireTime": "2023-11-07T05:31:56Z",
      "purgeTime": "2023-11-07T05:31:56Z",
      "deleteTime": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "state": "STATE_UNSPECIFIED",
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "minReplicaCount": 123,
      "maxReplicaCount": 123,
      "replicaCount": 123,
      "autoscalingPolicy": {
        "scaleUpWindow": "<string>",
        "scaleDownWindow": "<string>",
        "scaleToZeroWindow": "<string>",
        "loadTargets": {}
      },
      "baseModel": "<string>",
      "acceleratorCount": 123,
      "acceleratorType": "ACCELERATOR_TYPE_UNSPECIFIED",
      "precision": "PRECISION_UNSPECIFIED",
      "cluster": "<string>",
      "enableAddons": true,
      "draftTokenCount": 123,
      "draftModel": "<string>",
      "ngramSpeculationLength": 123,
      "numPeftDeviceCached": 123,
      "deploymentTemplate": "<string>",
      "autoTune": {
        "longPrompt": true
      },
      "region": "REGION_UNSPECIFIED",
      "engine": "ENGINE_UNSPECIFIED",
      "updateTime": "2023-11-07T05:31:56Z",
      "forTraining": true
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The Account Id

Query Parameters

​
pageSize
integer

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 ListDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeployments 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".

​
showDeleted
boolean

If set, DELETED deployments will be included.

Response

200 - application/json

A successful response.

The response is of type object.