API reference

The Videcoot Integration API lets your HR system manage positions, invite candidates to one-way video interviews, and pull back interview status, answer videos and AI analysis.

Read the guides first. It has a full walkthrough and a polling recipe.

Authentication

Send your organization's API key on every request:

Authorization: Bearer vdc_live_...

The scheme must be exactly Bearer, followed by one space and the key. Keys are created by an organization owner or admin in Organization → API keys, and Videcoot must enable API access for the organization first.

Server-side only. API keys are secrets. The API sends no CORS headers on purpose, so it can't be called from a browser.

Envelopes

• Single resource: { "data": { ... }, "timestamp": 1790330400000 }
• List: { "data": [ ... ], "meta": { "total", "page", "limit", "totalPages" }, "timestamp": ... }
• Error: { "success": false, "message": "...", "timestamp": ... }

timestamp is the server time in milliseconds since the Unix epoch. Date fields inside data are ISO 8601 strings in UTC.

Pagination

List endpoints take page (default 1) and limit (default 20, max 100).

Rate limits

• 300 requests per minute per IP address, checked before authentication.
• 120 requests per minute per API key, checked after authentication.

Responses carry the draft-7 RateLimit and RateLimit-Policy headers. On authenticated requests they describe the per-key limit. A 429 response also has a Retry-After header (seconds).

IDs and other organizations

IDs are 24-character hex strings. A malformed ID returns 400 Invalid ID. A well-formed ID that doesn't exist, or that belongs to another organization, returns 404.