Deployments.ai Docs
Artifacts

List artifacts

GET /v1/artifacts · SDK listArtifacts · CLI deployments artifact list

GET
/v1/artifacts

Requires artifacts:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
runId?string

Return only artifacts produced by this run.

Match^[0-9A-HJKMNP-TV-Z]{26}$
threadId?string

Return only artifacts associated with runs in this thread.

Match^[0-9A-HJKMNP-TV-Z]{26}$
type?string

Return only artifacts with this type label, such as report or input.

Length1 <= length <= 100
contentType?string

Return only artifacts with this media type, compared without parameters, or in this family, such as image/*.

Length3 <= length <= 255
createdAfter?string

Return only artifacts created at or after this canonical UTC millisecond timestamp.

Formatdate-time
createdBefore?string

Return only artifacts created at or before this canonical UTC millisecond timestamp.

Formatdate-time

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListArtifactsResponse

application/json
  1. response
artifacts*array<>
nextCursor?string|null
curl -X GET "https://example.com/v1/artifacts"
{  "artifacts": [    {      "agentDeploymentId": "string",      "artifactId": "string",      "byteSize": 0,      "contentType": "string",      "createdAt": "2019-08-24T14:15:22Z",      "fileName": "string",      "input": {        "kind": "image",        "mediaType": "image/jpeg"      },      "metadata": {        "property1": null,        "property2": null      },      "name": "string",      "object": "artifact",      "retentionExpiresAt": "2019-08-24T14:15:22Z",      "runId": "string",      "status": "available",      "threadId": "string",      "type": "string",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "visibility": "organization"    }  ],  "nextCursor": "string"}