vidocu-ai Courses API
Documents and videos turned into module-based courses
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vidocu-ai:vidocu-ai-courses-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Vidocu Ai Courses API
version: 1.14.0
contact:
name: Vidocu Support
url: https://vidocu.ai
license:
name: Proprietary
url: https://vidocu.ai/terms
description: 'Operations tagged Courses across 2 of this provider''s published API definitions: support-vidocu-openapi.json, vidocu-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vidocu.ai
description: Production
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Courses
description: Documents and videos turned into module-based courses
paths:
/v1/courses:
get:
tags:
- Courses
summary: List courses
description: '**Scope:** `courses:read`'
operationId: getV1Courses
parameters:
- name: status
in: query
required: false
schema:
type: string
enum:
- uploading
- extracting
- planning
- plan_ready
- failed
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- name: cursor
in: query
required: false
schema:
type: string
minLength: 1
responses:
'200':
description: Success
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`) or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Courses
summary: Create a course
description: 'From a document URL or an existing video. Planning starts immediately; poll the returned jobId.
**Scope:** `courses:write`
**Role permission:** `canCreate` (OAuth only — API keys carry full workspace permissions)'
operationId: postV1Courses
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
fileUrl:
type: string
format: uri
filename:
type: string
minLength: 1
maxLength: 300
sourceVideoId:
type: string
minLength: 1
instructions:
type: string
maxLength: 5000
pace:
type: string
enum:
- snackable
- course
- inDepth
aiVideo:
type: object
properties:
enabled:
type: boolean
stylePresetId:
type: string
minLength: 1
maxLength: 40
required:
- enabled
additionalProperties: false
additionalProperties: false
responses:
'202':
description: Course created; planning started
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
/v1/courses/{id}:
get:
tags:
- Courses
summary: Get a course
description: 'Includes its modules.
**Scope:** `courses:read`'
operationId: getV1CoursesId
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`) or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
patch:
tags:
- Courses
summary: Update a course
description: 'Title, planner instructions, project folder, and the access + completion settings for the learner link. Modules and status are owned by the pipeline. Settings are merged, so a partial patch leaves the fields it does not name alone.
**Scope:** `courses:write`
**Role permission:** `canEdit` (OAuth only — API keys carry full workspace permissions)'
operationId: patchV1CoursesId
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
minLength: 1
maxLength: 200
userInstructions:
type: string
maxLength: 5000
projectId:
type:
- string
- 'null'
minLength: 1
settings:
type: object
properties:
access:
type: object
properties:
identity:
type: string
enum:
- anonymous
- name
- email_name
- email_verified
- auth
openEnrollment:
type: boolean
allowedEmailDomains:
type: array
items:
type: string
minLength: 1
maxLength: 253
maxItems: 50
invitedEmails:
type: array
items:
type: string
format: email
maxItems: 2000
allowRoster:
type: boolean
additionalProperties: false
completion:
type: object
properties:
rule:
type: string
enum:
- watch
- watch_quiz
- manual
watchThresholdPct:
type: integer
minimum: 10
maximum: 100
sequential:
type: boolean
additionalProperties: false
trackProgress:
type: boolean
additionalProperties: false
accessCode:
type:
- string
- 'null'
maxLength: 200
pace:
type: string
enum:
- snackable
- course
- inDepth
aiVideo:
type: object
properties:
enabled:
type: boolean
stylePresetId:
type: string
minLength: 1
maxLength: 40
required:
- enabled
additionalProperties: false
additionalProperties: false
responses:
'200':
description: Success
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
tags:
- Courses
summary: Delete a course
description: 'Videos already generated from its modules are kept.
**Scope:** `courses:write`
**Role permission:** `canDelete` (OAuth only — API keys carry full workspace permissions)'
operationId: deleteV1CoursesId
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- true
id:
type: string
deleted:
type: boolean
enum:
- true
generatedVideosKept:
type: integer
description: Videos generated by the course that outlive it.
required:
- success
- id
- deleted
- generatedVideosKept
additionalProperties: false
description: Course deleted.
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
/v1/courses/{id}/progress:
get:
tags:
- Courses
summary: Get course progress
description: 'Per-module completion rates and a per-learner grid, including people who were invited and have not started.
**Scope:** `courses:read`'
operationId: getV1CoursesIdProgress
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`) or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
/v1/courses/{id}/storyboard:
get:
tags:
- Courses
summary: Get the storyboard
description: 'Every module''s scenes, omissions and warnings.
**Scope:** `courses:read`'
operationId: getV1CoursesIdStoryboard
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`) or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Courses
summary: Build a module's storyboard
description: '**Scope:** `courses:write`
**Role permission:** `canEdit` (OAuth only — API keys carry full workspace permissions)'
operationId: postV1CoursesIdStoryboard
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
moduleId:
type: string
minLength: 1
required:
- moduleId
additionalProperties: false
responses:
'202':
description: Job accepted; poll GET /v1/jobs/:id
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: That module is already being worked on
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
/v1/courses/{id}/generate:
post:
tags:
- Courses
summary: Generate a module's video
description: 'Needs a storyboard first.
**Scope:** `courses:write`
**Role permission:** `canEdit` (OAuth only — API keys carry full workspace permissions)'
operationId: postV1CoursesIdGenerate
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
moduleId:
type: string
minLength: 1
required:
- moduleId
additionalProperties: false
responses:
'202':
description: Job accepted; poll GET /v1/jobs/:id
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: That module is already generating
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
/v1/courses/{id}/build:
post:
tags:
- Courses
summary: Create a module's video in one step
description: 'The dashboard''s Create video: storyboard (when needed), AI visuals, narration and slides. Returns the new videoId at once; the video is in progress until the job completes. A ready module is rebuilt.
**Scope:** `courses:write`
**Role permission:** `canEdit` (OAuth only — API keys carry full workspace permissions)'
operationId: postV1CoursesIdBuild
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
moduleId:
type: string
minLength: 1
required:
- moduleId
additionalProperties: false
responses:
'202':
description: 'Build started: { jobId, videoId, projectId }; poll GET /v1/jobs/:id'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Invalid or missing credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: That module is already being built
'429':
description: Rate limit exceeded (60 req/min)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.vidocu.ai
description: Production
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Machine-readable code, e.g. `validation_error`, `insufficient_role`, `locked`
message:
type: string
required:
- code
- message
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An API key (`vdo_live_...`) or an OAuth 2.0 access token (`vdo_oat_...`).
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://vidocu.ai/oauth/authorize
tokenUrl: https://api.vidocu.ai/oauth/token
scopes:
videos:read: View videos in the workspace
videos:write: Upload and modify videos
projects:read: View project folders
projects:write: Create, update, and delete project folders
subtitles:read: View subtitles
subtitles:write: Generate and edit subtitles
export:write: Export videos
translate:write: Translate videos
voiceover:write: Generate voiceovers
article:read: View help articles
article:write: Generate help articles
analyze:write: Analyze videos
tools:read: List and view tools
tools:write: Execute tools
jobs:read: View job status
courses:read: View courses and their storyboards
courses:write: Create courses and run planning, storyboarding and generation
studio:read: View Studio projects and templates
studio:write: Create, edit and share Studio projects
modules:read: View training modules, results and qualifications
modules:write: Create, edit and translate training modules; record attempts and sign-offs
remixes:read: View remixes and their analysis
remixes:write: Create remixes and run analysis
recordings:read: View AI Recorder jobs and saved logins
recordings:write: Start recordings and manage saved logins
knowledge_base:read: View the knowledge base, its articles and analytics
knowledge_base:write: Create and edit knowledge base content
brand_kit:read: View Brand Kit settings, skills and glossary
brand_kit:write: Change Brand Kit settings, skills and glossary
usage:read: View usage statistics
voices:read: List available voices
voices:write: Delete cloned voices
avatars:read: List available AI avatars
avatars:write: Create custom AI avatars
webhooks:read: View webhook subscriptions
webhooks:write: Create, update, and delete webhooks
process:write: Use one-shot process endpoint
approvals:read: View approval rounds and requests
approvals:write: Request, decide and withdraw approvals
comments:read: View comments on videos
comments:write: Add and delete comments
locks:write: Lock and unlock videos and modules
x-refined-from:
- support-vidocu-openapi.json
- vidocu-ai-openapi.json