OpenAPI Spec
A complete OpenAPI 3.1 description of the API, covering every endpoint, request body, query parameter and error response.
It's generated, not maintained
The spec is produced from the API server's own request-validation schemas. The shapes it describes are the shapes the server validates against - they can't drift apart, because they're the same definitions.
That means: if a field appears in the spec, the server accepts it. If it doesn't, the server rejects it.
Generating a client
# TypeScript
npx openapi-typescript https://vidocu.ai/docs/openapi.json -o vidocu.d.ts
# Python
openapi-python-client generate --url https://vidocu.ai/docs/openapi.json
Any OpenAPI 3.1 generator works. The spec validates clean under Redocly.
What isn't in it
Response bodies are described by status code and meaning rather than by full schema. Request validation is enforced by schemas we can generate from; responses are assembled per route, so documenting them as schemas would mean hand-writing shapes that could drift - exactly the problem this file exists to avoid. The endpoint pages in this documentation show a real response example for each operation.
Authentication is declared as bearer auth (an API key or an OAuth access token) plus the OAuth 2.0 authorization-code flow with the full scope list. See Authentication and OAuth Scopes.