Version 1.0.0

Videcoot Integration API

Server-to-server API for connecting an HR system to Videcoot.

Guides

• Introduction

  What the Integration API does, environments, and how to get an API key.

• Authentication and first call

  Send your API key and make your first request.

• Responses and errors

  Response envelopes, error format and status codes.

• Rate limits

  Per-IP and per-key limits, headers and retrying.

• End-to-end walkthrough

  Create a position, invite a candidate, poll progress and read the AI analysis.

• Idempotency

  Safe retries with externalId, and re-inviting a candidate.

• Polling and statuses

  Sync interviews with updatedSince, and what each status means.

• Videos

  Answer video links and how to handle them.

• Changelog

  Changes to the Integration API.

API reference