Generate Article

POST /v1/videos/:id/article

Generate a step-by-step help article from the video's transcript. This is a synchronous endpoint — the article is returned directly in the response.

Prerequisites

The video must be analyzed first (subtitles must exist).

Path parameters

Parameter	Type	Required	Description
id	string	Yes	Video ID

Request body

Parameter	Type	Required	Default	Description
regenerate	boolean	No	false	Set to true to generate a new article even if one exists

Example

curl -X POST https://api.vidocu.ai/v1/videos/vid_.../article \
  -H "Authorization: Bearer vdo_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Response 200 OK

{
  "videoId": "vid_1708300000000_abc1234",
  "article": {
    "title": "How to Configure Dashboard Settings",
    "content": "## Step 1: Open the settings panel\n\nNavigate to the settings icon in the top-right corner...\n\n## Step 2: Configure your preferences\n\n..."
  }
}

Article object fields

Field	Type	Description
title	string	Generated article title
content	string	Article body in Markdown format

Caching

If regenerate is false (default) and an article already exists for this video, the cached article is returned immediately without making a new generation request.

Set regenerate: true to force a fresh article.

Errors

Status	Code	Cause
400	validation_error	Video must be analyzed before generating an article
401	authentication_error	Invalid or missing API key
404	not_found	Video not found
500	internal_error	Article generation not configured or generation failed