GET
/
v4
/
model-deployments
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const modelDeployment of client.models.deployments.listAll()) {
    console.log(modelDeployment.id);
  }
}

main();
{
  "items": [
    {
      "name": "<string>",
      "model_creation_parameters": {},
      "model_endpoint_id": "<string>",
      "model_instance_id": "<string>",
      "vendor_configuration": {
        "min_workers": 0,
        "max_workers": 1,
        "per_worker": 10,
        "vendor": "LAUNCH"
      },
      "deployment_metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "status": "<string>"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

sort_by
enum<string>[]
Available options:
model_creation_parameters:asc,
model_creation_parameters:desc,
model_endpoint_id:asc,
model_endpoint_id:desc,
model_instance_id:asc,
model_instance_id:desc,
vendor_configuration:asc,
vendor_configuration:desc,
deployment_metadata:asc,
deployment_metadata:desc,
status:asc,
status:desc,
id:asc,
id:desc,
created_at:asc,
created_at:desc,
account_id:asc,
account_id:desc,
created_by_user_id:asc,
created_by_user_id:desc,
created_by_user:asc,
created_by_user:desc,
name:asc,
name:desc
account_id
string | null

Optional filter by account id

page
integer
default:
1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x > 1
limit
integer
default:
100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 < x < 10000

Response

200
application/json
Successful Response
items
object[]
required

The data returned for the current page.

total_item_count
integer
required

The total number of items of the query

current_page
integer
required

The current page number.

items_per_page
integer
required

The number of items per page.