Substy Developers
Media and vault

Complete vault upload

Finalize an uploadHandle after every expected part has been stored. Returns upload status and provider processing identifiers; processing may continue before media becomes available. OnlyFans performs its configured upload confirmation unless skipConfirmation was set during initialization. Inspect status after an uncertain outcome.

POST/v1/agencies/{agencyId}/vault/uploads/{uploadHandle}/completion

Finalize an uploadHandle after every expected part has been stored. Returns upload status and provider processing identifiers; processing may continue before media becomes available. OnlyFans performs its configured upload confirmation unless skipConfirmation was set during initialization. Inspect status after an uncertain outcome.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agencies/string/vault/uploads/497f6eca-6276-4993-bfeb-53cbbbba6f08/completion" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "uploadHandle": "string",    "creatorId": "string",    "phase": "COMPLETED",    "chunkSize": 0,    "totalParts": 0,    "receivedParts": [      0    ],    "expiresAt": "string",    "result": null  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

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.

Read media bytes GET

Read a creator vault media file by creatorId and mediaId. Choose full, preview or thumb; offset and maxBytes are byte counts. Returns base64 content, contentType, byteLength and nextOffset. Continue from nextOffset until null to retrieve the whole file; each call reads at most 1 MiB.