> ## Documentation Index
> Fetch the complete documentation index at: https://www.dropfans.io/developers/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /api/external/vault/video-status — Check video transcoding status (batch)

> Transcoding status + duration for a batch of video GUIDs (`bunnyStreamId` values from your vault items).

- Source: https://www.dropfans.io/developers/reference/video-status
- Section: API reference
- OpenAPI: https://www.dropfans.io/developers/openapi.json

Transcoding 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.

> [!WARNING] Silent truncation and omission
> 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

`Authorization: Bearer dpfn_...` — an API key generated in the creator's dashboard (Vault → API Connect). One key = one creator. Missing or invalid keys return 401 `{"error":"Unauthorized","code":"unauthorized"}`.

## Request body (application/json)

| Field | Type | Required | Description |
|---|---|---|---|
| `videoIds` | string[] | yes | Stream GUIDs to check (≤50 — extras silently dropped). Non-strings are filtered out; an empty array returns {"statuses":{}}. |

Example — Check two videos:

```json
{
  "videoIds": [
    "c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
    "0f3d9a11-2222-4333-a444-5e66f7a8b9c0"
  ]
}
```

## Responses

### 200

Status map keyed by the GUIDs you sent (unresolvable ids omitted).

| Field | Type | Required | Description |
|---|---|---|---|
| `statuses` | VideoStatusMap | yes | GUID → status. |

```json
{
  "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. |

## Rate limiting

Per-key fixed windows by tier (Personal 60/min · 5,000/day; approved apps 300/min · 50,000/day; Dropfans-operated integrations exempt). Read the live values from X-RateLimit-Tier, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and their -Day variants; a 429 carries Retry-After and `{"error":"Rate limit exceeded","code":"rate_limited"}`. See [Rate limits](https://www.dropfans.io/developers/concepts/rate-limits.md).

## Code samples

### curl

```bash
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"
  ]
}'
```

### Node

```javascript
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());
```

### Python

```python
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())
```

## OpenAPI

```json
{
  "method": "POST",
  "path": "/api/external/vault/video-status",
  "operationId": "videoStatus",
  "tags": [
    "vault"
  ],
  "summary": "Check video transcoding status (batch)",
  "description": "Transcoding status + duration for a batch of video GUIDs (`bunnyStreamId` values from your vault items).\n\nA 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.\n\n> [!WARNING] Silent truncation and omission\n> 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\".",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "videoIds": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "A Bunny Stream GUID (vault item `bunnyStreamId`)."
              },
              "description": "Stream GUIDs to check (≤50 — extras silently dropped). Non-strings are filtered out; an empty array returns {\"statuses\":{}}.",
              "maxItems": 50
            }
          },
          "required": [
            "videoIds"
          ]
        },
        "examples": {
          "batch": {
            "summary": "Check two videos",
            "value": {
              "videoIds": [
                "c2f7f9e2-1111-4222-b333-4d55e6f7a8b9",
                "0f3d9a11-2222-4333-a444-5e66f7a8b9c0"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Status map keyed by the GUIDs you sent (unresolvable ids omitted).",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "statuses": {
                "type": "object",
                "description": "Keyed by the Bunny Stream GUIDs you sent. Ids you don’t own, and ids whose Bunny lookup errored, are OMITTED (not reported as failed) — treat a missing key as \"still gated\".",
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "isReady": {
                      "type": "boolean",
                      "description": "Transcoding finished — the video is playable and forwardable."
                    },
                    "isProcessing": {
                      "type": "boolean",
                      "description": "Still transcoding — poll again later."
                    },
                    "isFailed": {
                      "type": "boolean",
                      "description": "Encoding failed — re-upload."
                    },
                    "length": {
                      "type": "integer",
                      "description": "Duration in seconds, once known.",
                      "example": 74
                    }
                  },
                  "required": [
                    "isReady",
                    "isProcessing",
                    "isFailed"
                  ],
                  "description": "Keyed by the Bunny Stream GUIDs you sent. Ids you don’t own, and ids whose Bunny lookup errored, are OMITTED (not reported as failed) — treat a missing key as \"still gated\"."
                },
                "propertyNames": {
                  "description": "Keys are the ids you sent ({videoId})."
                }
              }
            },
            "required": [
              "statuses"
            ]
          },
          "example": {
            "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
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The body is not valid JSON.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message describing what went wrong.",
                "example": "Vault item not found"
              }
            },
            "required": [
              "error"
            ]
          },
          "example": {
            "error": "Invalid JSON body"
          }
        }
      }
    },
    "401": {
      "description": "Missing or invalid API key.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Unauthorized",
            "code": "unauthorized"
          }
        }
      }
    },
    "403": {
      "description": "The app this key belongs to has been suspended by Dropfans. Every request fails with this until the app is reinstated — surface it to the creator and contact Dropfans.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "This integration has been suspended by Dropfans. Contact the app developer.",
            "code": "app_suspended"
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded for the current minute or day window. Wait Retry-After seconds and retry.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "Retry-After": {
          "description": "Seconds to wait before retrying (sent with 429s).",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Rate limit exceeded",
            "code": "rate_limited"
          }
        }
      }
    }
  },
  "x-codeSamples": [
    {
      "lang": "cURL",
      "label": "curl",
      "source": "curl -X POST \"https://www.dropfans.io/api/external/vault/video-status\" \\\n  -H \"Authorization: Bearer $DROPFANS_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"videoIds\": [\n    \"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9\",\n    \"0f3d9a11-2222-4333-a444-5e66f7a8b9c0\"\n  ]\n}'"
    },
    {
      "lang": "JavaScript",
      "label": "Node",
      "source": "const res = await fetch(`https://www.dropfans.io/api/external/vault/video-status`, {\n  method: 'POST',\n  headers: {\n    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n    'Content-Type': 'application/json',\n  },\n  body: JSON.stringify({\n    \"videoIds\": [\n      \"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9\",\n      \"0f3d9a11-2222-4333-a444-5e66f7a8b9c0\"\n    ]\n  }),\n});\nconsole.log(await res.json());"
    },
    {
      "lang": "Python",
      "source": "import os\nimport requests\n\nres = requests.post(\n    \"https://www.dropfans.io/api/external/vault/video-status\",\n    headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n    json={\n        \"videoIds\": [\n            \"c2f7f9e2-1111-4222-b333-4d55e6f7a8b9\",\n            \"0f3d9a11-2222-4333-a444-5e66f7a8b9c0\",\n        ],\n    },\n)\nprint(res.json())"
    }
  ],
  "x-dropfans-docs": "https://www.dropfans.io/developers/reference/video-status"
}
```

---

Previous: [Finish a video upload (step 3 of 3)](https://www.dropfans.io/developers/reference/complete-video-upload.md) · Next: [Create a sellable drop from vault items](https://www.dropfans.io/developers/reference/create-drop.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)
