Assets

Asset upload and retrieval endpoints.

Create an asset upload

POST/assets

Complete a signed asset upload

POST/assets/{assetId}/complete

Retry a signed asset upload

POST/assets/{assetId}/retry

List assets

GET/assets

Get an asset

GET/assets/{assetId}

ModelsExpand Collapse

AssetCreateResponse object { asset_id, status, uploaded_via, 6 more }

asset_id: string

Asset identifier

status: "pending_upload" or "ready" or "failed"

One of the following:

"pending_upload"

"ready"

"failed"

uploaded_via: "url" or "signed_url"

Asset source

One of the following:

"url"

"signed_url"

url: string

Asset URL

formaturi

visibility: "workspace"

workspace_id: string

Workspace identifier

expires_at: optional string

Expiration time for the upload URL

formatdate-time

upload: optional object { content_type, file_field, form_fields, 2 more }

content_type: "multipart/form-data"

file_field: "file"

form_fields: map[string]

Upload form fields

method: "POST"

url: string

Upload URL

formaturi

upload_url: optional string

Upload URL (serialized)

AssetCompleteResponse object { asset_id, status, url, 6 more }

asset_id: string

Asset identifier

status: "pending_upload" or "ready" or "failed"

One of the following:

"pending_upload"

"ready"

"failed"

url: string

Asset URL

formaturi

visibility: "workspace"

workspace_id: string

Workspace identifier

expires_at: optional string

Expiration time for the upload URL

formatdate-time

failure_message: optional string

Failure message when the asset is in failed status

upload: optional object { content_type, file_field, form_fields, 2 more }

content_type: "multipart/form-data"

file_field: "file"

form_fields: map[string]

Upload form fields

method: "POST"

url: string

Upload URL

formaturi

upload_url: optional string

Upload URL (serialized)

AssetRetryResponse object { asset_id, status, url, 6 more }

asset_id: string

Asset identifier

status: "pending_upload" or "ready" or "failed"

One of the following:

"pending_upload"

"ready"

"failed"

url: string

Asset URL

formaturi

visibility: "workspace"

workspace_id: string

Workspace identifier

expires_at: optional string

Expiration time for the upload URL

formatdate-time

failure_message: optional string

Failure message when the asset is in failed status

upload: optional object { content_type, file_field, form_fields, 2 more }

content_type: "multipart/form-data"

file_field: "file"

form_fields: map[string]

Upload form fields

method: "POST"

url: string

Upload URL

formaturi

upload_url: optional string

Upload URL (serialized)

AssetListResponse object { asset_id, content_type, created_at, 12 more }

asset_id: string

Asset identifier

content_type: string

Asset content type

created_at: number

description: string

Asset description

height: number

name: string

Asset name

size_bytes: number

status: "pending_upload" or "ready" or "failed"

One of the following:

"pending_upload"

"ready"

"failed"

upload_content_type: string

Content type provided at upload time

uploaded_via: string

Asset source

url: string

Asset URL

formaturi

width: number

workspace_id: string

Workspace identifier

node_id: optional string

Associated node identifier

project_id: optional string

Project identifier

AssetRetrieveResponse object { asset_id, content_type, created_at, 11 more }

asset_id: string

Asset identifier

content_type: string

Asset content type

created_at: string

Asset creation time (ISO 8601 datetime)

formatdate-time

description: string

Asset description

failure_message: string

Failure message when the asset is in failed status

height: number

name: string

Asset name

size_bytes: number

status: "pending_upload" or "ready" or "failed"

One of the following:

"pending_upload"

"ready"

"failed"

upload_content_type: string

Content type provided at upload time

uploaded_via: string

Asset source

url: string

Asset URL

formaturi

width: number

workspace_id: string

Workspace identifier