Operations

Generate a help article

Synchronous — returns the article inline.

Scope: article:write

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

post/v1/videos/{id}/article

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/videos/{id}/article
  • 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

regenerateboolean
languagestring
instructionsstring
format'markdown' | 'html'
stylestring

Response

Success

Changes

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