Skip to content
Limited-time offerevery video just HK$1only 1,000, first come first servedGet it now
Axiom Lab
Developer docs

Reference

API reference · Assets

Upload PDFs, slides and pictures; reference the returned asset ids in a plan.

View Markdown

List Assets

GET/v1/assets

API key requiredSuccess 200

Parameters

NameTypeDescription
limitqueryintegerDefault 50; range 1–200
cursorquerystringlength ≤ 256; nullable
afterquerystringlength ≤ 256; nullable
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Response 200 application/json

NameTypeDescription
datarequiredarray<object>
data[].idrequiredstring
data[].project_idrequiredstringnullable
data[].filenamerequiredstring
data[].bytesrequiredinteger
data[].sha256requiredstring
data[].created_atrequirednumber
next_cursorstringOpaque; pass as cursor (or the after alias) for the next page; nullable
has_morebooleanDefault false

Example

curl "https://axiomlab.online/v1/assets" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Upload Asset

POST/v1/assets

API key requiredSuccess 201

Parameters

NameTypeDescription
Idempotency-KeyheaderstringA unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Request body multipart/form-data

NameTypeDescription
filerequiredfile

Response 201 application/json

NameTypeDescription
idrequiredstring
project_idrequiredstringnullable
filenamerequiredstring
bytesrequiredinteger
sha256requiredstring
created_atrequirednumber

Example

curl -X POST "https://axiomlab.online/v1/assets" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@deck.pdf"

Get Asset

GET/v1/assets/{asset_id}

API key requiredSuccess 200

Parameters

NameTypeDescription
asset_idrequiredpathstring
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Response 200 application/json

NameTypeDescription
idrequiredstring
project_idrequiredstringnullable
filenamerequiredstring
bytesrequiredinteger
sha256requiredstring
created_atrequirednumber

Example

curl "https://axiomlab.online/v1/assets/<asset_id>" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Delete Asset

DELETE/v1/assets/{asset_id}

API key requiredSuccess 200

Remove an upload and its bytes. Jobs that already consumed it keep their own copies.

Parameters

NameTypeDescription
asset_idrequiredpathstring
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Response 200 application/json

NameTypeDescription
idrequiredstring
deletedbooleanDefault true

Example

curl -X DELETE "https://axiomlab.online/v1/assets/<asset_id>" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Download Asset

GET/v1/assets/{asset_id}/file

API key requiredSuccess 200

Parameters

NameTypeDescription
asset_idrequiredpathstring
X-Project-IDheaderstringThe project to act on; the default project when omitted; nullable

Response 200 application/octet-stream

Returns the file bytes.

Example

curl "https://axiomlab.online/v1/assets/<asset_id>/file" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

← All endpoints