From the creator of tx|Headless primitives for AI agentsVisit tx docs

API Reference

storage Endpoints

API endpoints for the storage resource group

storage Endpoints

`POST /v1/storage/upload-url`

Responses

Status	Description
`200`	Success
`400`	The request did not match the expected schema
`401`	Unauthorized
`402`	PaymentRequired
`403`	Forbidden
`404`	NotFound
`409`	Conflict
`429`	TooManyRequests
`500`	InternalError

`POST /v1/storage/download-url`

Responses

Status	Description
`200`	Success
`400`	The request did not match the expected schema
`401`	Unauthorized
`402`	PaymentRequired
`403`	Forbidden
`404`	NotFound
`409`	Conflict
`429`	TooManyRequests
`500`	InternalError

`POST /v1/storage/delete`

Responses

Status	Description
`200`	Success
`400`	The request did not match the expected schema
`401`	Unauthorized
`402`	PaymentRequired
`403`	Forbidden
`404`	NotFound
`409`	Conflict
`429`	TooManyRequests
`500`	InternalError

`GET /v1/storage/objects`

Parameters

Name	In	Type	Required	Description
`prefix`	query	`string`	No	---

Responses

Status	Description
`200`	Success
`400`	The request did not match the expected schema
`401`	Unauthorized
`402`	PaymentRequired
`403`	Forbidden
`404`	NotFound
`409`	Conflict
`429`	TooManyRequests
`500`	InternalError

`GET /v1/storage/objects/{key}/metadata`

Parameters

Name	In	Type	Required	Description
`key`	path	`string`	Yes	---

Responses

Status	Description
`200`	Success
`400`	The request did not match the expected schema
`401`	Unauthorized
`402`	PaymentRequired
`403`	Forbidden
`404`	NotFound
`409`	Conflict
`429`	TooManyRequests
`500`	InternalError

permissions Endpoints

API endpoints for the permissions resource group

roles Endpoints

API endpoints for the roles resource group

On this page

storage Endpoints POST /v1/storage/upload-urlResponses POST /v1/storage/download-urlResponses POST /v1/storage/deleteResponses GET /v1/storage/objectsParameters Responses GET /v1/storage/objects/{key}/metadataParameters Responses