Atmee.aiDocs
APIAPI referenceAvatars

Upload status

GET
/v1/uploads/{uploadId}

pending until the file arrives, then uploaded (usable once), consumed once a create or replace used it, or expired an hour after it was created. Only the account that created it sees it. Requires avatars:read or avatars:write.

Authorization

headerX-Api-Key<token>

Secret embed API key (sk_atmee_...; keys minted before 2026-09 carry sk_live_...), held by the customer's own backend and never sent to a browser. Format: X-Api-Key: sk_atmee_....

Path Parameters

uploadId*string
Formatuuid

Response Body

The upload.

application/json
  1. response
uploadId*string
Formatuuid
kind*UploadKind
Value in"portrait""voice""knowledge"
status*string
Value in"pending""uploaded""consumed""expired"
size?integer

Bytes received, once uploaded.

Formatint64
contentType?string

The declared type, then the type the file was sent with.

fileName?string
expiresAt*string
Formatdate-time
Example Request
curl -X GET 'https://api.atmanity.us/v1/uploads/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "uploadId": "ef523ba8-509e-47af-8e2c-5fa751596497",  "kind": "portrait",  "status": "pending",  "size": 0,  "contentType": "string",  "fileName": "string",  "expiresAt": "2019-08-24T14:15:22Z"}
Upload status — Atmee Docs