Check video transcoding status (batch)
Transcoding status + duration for a batch of video GUIDs (`bunnyStreamId` values from your vault items).
/api/external/vault/video-statusTranscoding status + duration for a batch of video GUIDs (bunnyStreamId values from your vault items).
A freshly uploaded video is not forwardable or playable until isReady — poll this while isProcessing. Reasonable interval: every 15–30 seconds while you wait on a specific video.
At most 50 ids are processed per call — extras are dropped without an error, so chunk larger lists. Ids you don't own, and ids whose lookup errored, are omitted from the response rather than reported: treat a missing key as "not ready".
Authentication
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
An agency's own key can call this for a creator it manages by adding X-Dropfans-Account: <account id> (needs canManageVault). See Agencies.
Request body
Content type: application/json
| Name | Type | Required | Description |
|---|---|---|---|
videoIds | string[] | Required | Stream GUIDs to check (≤50 — extras silently dropped). Non-strings are filtered out; an empty array returns {"statuses":{}}. Max items: 50 |
{
"videoIds": [
"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
"0f3d9a11-2222-4333-a444-5e66f7a8b9c0"
]
}Responses
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
statuses | VideoStatusMap | GUID → status.Show child attributes
|
{
"statuses": {
"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9": {
"isReady": true,
"isProcessing": false,
"isFailed": false,
"length": 74
},
"0f3d9a11-2222-4333-a444-5e66f7a8b9c0": {
"isReady": false,
"isProcessing": true,
"isFailed": false
}
}
}Errors
| Status | Body | When |
|---|---|---|
| 400 | {"error":"Invalid JSON body"} | The body is not valid JSON. |
| 401 | {"error":"Unauthorized","code":"unauthorized"} | Missing or invalid API key. |
| 400 | {"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"} | `X-Dropfans-Account` is not an account id. |
| 403 | {"error":"This key cannot act for that account.","code":"account_not_managed"} | `X-Dropfans-Account` names an account this key cannot act for: not an agency’s own key, no ACCEPTED management, or the agency or account is suspended, banned or deleted (an unknown id gets the same answer). |
| 403 | {"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canManageVault"} | With `X-Dropfans-Account`: the agency lacks `canManageVault` on that account. |
Rate limiting
Every response carries the X-RateLimit-Tier header and, on limited tiers, the per-minute and per-day trios — read X-RateLimit-Remaining and X-RateLimit-Reset instead of hardcoding limits. Details in Rate limits.
Code samples
curl -X POST "https://www.dropfans.io/api/external/vault/video-status" \
-H "Authorization: Bearer $DROPFANS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"videoIds": [
"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
"0f3d9a11-2222-4333-a444-5e66f7a8b9c0"
]
}'const res = await fetch(`https://www.dropfans.io/api/external/vault/video-status`, {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"videoIds": [
"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
"0f3d9a11-2222-4333-a444-5e66f7a8b9c0"
]
}),
});
console.log(await res.json());import os
import requests
res = requests.post(
"https://www.dropfans.io/api/external/vault/video-status",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
json={
"videoIds": [
"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
"0f3d9a11-2222-4333-a444-5e66f7a8b9c0",
],
},
)
print(res.json())Questions? [email protected]