Get upload status

Returns the current status and metadata of an upload.

GET /v1/uploads/{uploadId}

Get upload status

cURL

curl --request GET \
  --url https://api.example.com/v1/uploads/{uploadId} \
  --header 'Authorization: Bearer <token>'

200

{
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "fileName": "<string>",
  "fileSize": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization · string · header · required

Clerk session JWT or Unkey API key passed as Bearer token

Headers

x-adclear-workspace-id · string<uuid>

Workspace ID fallback. Required when authenticating with a Bearer token in environments where cookies cannot be shared (e.g. preview). Not needed for API key auth (workspace is embedded in the key metadata) or when the workspace cookie is present.

Example:

"43dc2a1c-3384-41b5-a6e9-3b2d607d0fae"

x-external-user-id · string

Required when authenticating with an API key. Identifies the end-user making the request. Ignored when authenticating with a Bearer token (the user ID is extracted from the token).

Example:

"user_abc123"

x-external-user-email · string<email>

Optional. Email of the external user, used for audit logging. Only applicable when authenticating with an API key.

Example:

"[e-mail]"

Path Parameters

uploadId · string<uuid> · required

Upload ID

Response

200

application/json

Upload status

uploadId · string<uuid> · required

status · enum<string> · required

Available options: pending, uploading, completed, failed

fileName · string · required

fileSize · integer | null · required

createdAt · string<date-time> · required

correlationId · string<uuid> · required

Correlation ID for request tracing. Include in support requests.