Deployments.ai Docs
Brains

Issue a Brain upload ticket

POST /v1/brains/{brainId}/sources/{sourceId}/uploads · SDK createBrainUploadTicket · CLI deployments brain-upload create

POST
/v1/brains/{brainId}/sources/{sourceId}/uploads

Requires brains:write.

Authorization

tenantJwt
headerAuthorizationBearer <token>

Tenant JWT carrying organization, project, and environment claims.

Path Parameters

brainId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
sourceId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-organization*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string

Limited to 500 UTF-8 bytes.

Length1 <= length <= 500

Request Body

application/json
  1. body
expectedByteSize*integer
Range1 <= value <= 8388608
expectedContentHash*string
Match^sha256:[a-f0-9]{64}$
mediaType*string
Value in"application/json""application/pdf""text/csv""text/html""text/markdown""text/plain"

Response Body

BrainUploadTicketResponse

application/json
  1. response
bodyRef?
brainId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
completedAt?string
consumedAt?string
createdAt*string
directUpload?
documentId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
documentVersionId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
expectedByteSize*integer
Range0 <= value
expectedContentHash*string
expiresAt*string
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
mediaType*string
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
revisionClaimId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
sourceId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
status*string
Value in"completed""consumed""expired""issued""rejected""streaming"
updatedAt*string
uploadPath?string
version*integer
Range0 <= value
curl -X POST "https://example.com/v1/brains/string/sources/string/uploads" \  -H "x-deployments-organization: string" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedByteSize": 1,    "expectedContentHash": "string",    "mediaType": "application/json"  }'
{  "bodyRef": {    "bucket": "string",    "byteSize": 0,    "contentType": "string",    "etag": "string",    "fileName": "string",    "key": "string",    "sha256": "string",    "versionId": "string"  },  "brainId": "string",  "completedAt": "string",  "consumedAt": "string",  "createdAt": "string",  "directUpload": {    "completePath": "string",    "expiresAt": "string",    "headers": {      "property1": "string",      "property2": "string"    },    "method": "PUT",    "url": "string"  },  "documentId": "string",  "documentVersionId": "string",  "expectedByteSize": 0,  "expectedContentHash": "string",  "expiresAt": "string",  "id": "string",  "mediaType": "string",  "organizationId": "string",  "revisionClaimId": "string",  "sourceId": "string",  "status": "completed",  "updatedAt": "string",  "uploadPath": "string",  "version": 0}