Substy Developers
Media and vault

Get vault upload status

Inspect an uploadHandle for its phase, expiry, receivedParts and processing result. Use receivedParts to identify missing chunks before completing the upload. COMPLETED means the provider accepted processing; inspect returned media identifiers for availability. Check UNKNOWN outcomes before repeating completion.

GET/v1/agencies/{agencyId}/vault/uploads/{uploadHandle}

Inspect an uploadHandle for its phase, expiry, receivedParts and processing result. Use receivedParts to identify missing chunks before completing the upload. COMPLETED means the provider accepted processing; inspect returned media identifiers for availability. Check UNKNOWN outcomes before repeating completion.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
uploadHandle*string
Match^([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)$
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/vault/uploads/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "uploadHandle": "string",    "creatorId": "string",    "phase": "COMPLETED",    "chunkSize": 0,    "totalParts": 0,    "receivedParts": [      0    ],    "expiresAt": "string",    "result": null  },  "meta": {    "requestId": "string"  }}

Upload vault part PUT

Upload one file chunk using an uploadHandle from initialize_vault_upload. Supply a one-based partNumber, base64 bytes and their lowercase SHA-256 checksum. Each chunk must match chunkSize except the final remainder. Returns receivedParts; replacing a stored part with different bytes is rejected.

Cancel vault upload DELETE

Cancel an uploadHandle and remove its staged parts. Returns the updated upload status. Uploads already finalizing, completed or in an uncertain state cannot be cancelled with this tool.