Skip to main content

Postman Collection

Import our ready-made Postman collection to start testing the Vidocu API in minutes.

Download Postman Collection

Setup​

  1. Open Postman and click Import
  2. Select the downloaded JSON file
  3. Open the collection's Variables tab and set:
VariableValue
base_urlhttps://api.vidocu.ai
api_keyYour API key (from the Dashboard)
  1. Click Save

What's included​

Every endpoint in the API - 125 requests across 15 folders, grouped the same way as these docs:

FolderRequestsFolderRequests
Knowledge Center22Courses8
Training Modules16AI Recorder8
Brand Kit14Videos6
Governance10Reference6
Operations10Projects5
Remix9Webhooks4
Tools3Jobs / Usage2 each

The collection is generated from the OpenAPI spec, so it can't fall behind the API - a build fails if it does. Don't edit it by hand; changes are overwritten.

Request bodies are pre-filled with an example derived from each endpoint's schema, and optional query parameters appear as disabled rows so you can see what's available without sending them.

Auto-saved variables​

Creating a resource stores its id in a collection variable, so the next request can use it without copying anything:

RequestSaves
Upload a videovideo_id
Create a projectproject_id
Create an articlearticle_id
Create a remixremix_id
Start a recordingjob_id

Endpoints with an :id in the path use {{resource_id}} - set it once per folder you're testing.

Suggested test flow​

  1. Upload a video - creates a draft and saves video_id
  2. Analyze a video - starts transcription and analysis
  3. Get job status - poll until status is completed
  4. Get subtitles - check the transcript
  5. Generate a help article - from the transcript
  6. Export a video - render the finished file

Collection auth​

Authentication is set at the collection level using a Bearer token. All requests inherit it automatically — no need to set auth on individual requests.