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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vidocu-ai:vidocu-ai-reference-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Vidocu Ai Reference API
  version: 1.14.0
  contact:
    name: Vidocu Support
    url: https://vidocu.ai
  license:
    name: Proprietary
    url: https://vidocu.ai/terms
  description: 'Operations tagged Reference 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: Reference
  description: Static reference data
paths:
  /v1/voices:
    get:
      tags:
      - Reference
      summary: List voices
      description: 'Voices accepted as `voiceId`. The workspace''s own clones come first, marked `custom: true`.


        **Scope:** `voices:read`'
      operationId: getV1Voices
      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'
    servers:
    - url: https://api.vidocu.ai
      description: Production
  /v1/avatars:
    get:
      tags:
      - Reference
      summary: List AI avatars
      description: 'Avatars usable with the AI avatar generator. Search with `q` — the stock library is large.


        **Scope:** `avatars:read`'
      operationId: getV1Avatars
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 100
      - name: gender
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 20
      - 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: 50
      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:
      - Reference
      summary: Create a photo avatar
      description: 'Builds a photo avatar from a public image URL and adds it to the workspace. Enterprise plan required.


        **Scope:** `avatars:write`


        **Role permission:** `canEditSettings` (OAuth only — API keys carry full workspace permissions)'
      operationId: postV1Avatars
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                imageUrl:
                  type: string
                  format: uri
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
              required:
              - imageUrl
              - name
              additionalProperties: false
      responses:
        '201':
          description: Avatar created
        '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/avatars/{id}:
    get:
      tags:
      - Reference
      summary: Get an AI avatar
      description: 'Checks the workspace''s own avatars first, then the stock library.


        **Scope:** `avatars:read`'
      operationId: getV1AvatarsId
      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/voices/{id}:
    delete:
      tags:
      - Reference
      summary: Delete a cloned voice
      description: 'Removes one of the workspace''s cloned voices, at the provider as well. Stock voices can''t be deleted; cloning is app-only (it needs recorded consent).


        **Scope:** `voices:write`


        **Role permission:** `canEditSettings` (OAuth only — API keys carry full workspace permissions)'
      operationId: deleteV1VoicesId
      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
                  voiceId:
                    type: string
                  deleted:
                    type: boolean
                    enum:
                    - true
                required:
                - success
                - voiceId
                - deleted
                additionalProperties: false
                description: Voice 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/languages:
    get:
      tags:
      - Reference
      summary: List supported languages
      description: The codes every `language` parameter accepts.
      operationId: getV1Languages
      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'
        '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