Skip to main content
POST
Create file URL

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid
string<uuid>
required

File identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Request body schema.

expiresInSeconds
integer

How long the signed URL works, up to 10800 (3 hours). Defaults to 3600.

Required range: 1 <= x <= 10800
download
boolean

Ask the browser to save the file under its name instead of rendering it.

Response

Create file URL

url
string
required

Signed URL that serves the file without auth until it expires.

expiresAt
string
required

When the signed URL stops working.

publicUrl
string

Stable unauthenticated link, present only when the file is public. It stops working as soon as the file is made private or deleted.