Operations

Analyze a video

Scope: analyze:write

Role permission: canEdit (OAuth only — API keys carry full workspace permissions)

post/v1/videos/{id}/analyze

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/videos/{id}/analyze
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Path parameters

idstring required

Request body

videoContextstring
companyContextstring
languagestring
tonestring
contentStyle'how-to' | 'sop' | 'promotional' | 'training' | 'announcement'
productNamestring
scriptSource'video' | 'transcript' | 'original' | 'custom'
customScriptstring
scriptSkillIdstring
forceRefreshboolean
analysisModel'gemini'
subtitleModel'openai' | 'gemini'
autoZoomboolean

Response

Job accepted; poll GET /v1/jobs/:id

jobIdstring required

Poll this via GET /v1/jobs/{id}.

status'pending' required

Changes

No recorded changes to this operation across all 1 revision of this API.