Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aansi.qode.world/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

Every endpoint requires an API key sent as a Bearer token:
Authorization: Bearer qint_xxxxxxxxxxxxxxxxxxxxxxxxx
API keys are issued by the Aansi team. Each key is bound to your account and the jobs you own — calls made with the key will only see and operate on those jobs. Keys begin with the qint_ prefix. Treat them like passwords: store securely, never embed in client-side code, and rotate immediately if you suspect compromise. If you need a key rotated or revoked, contact the Aansi team.

Response envelope

Successful responses return JSON of the form:
{
  "success": true,
  "data": { ... }
}
Errors return:
{
  "status": 401,
  "errors": "Invalid API key"
}
errors is either a string or, on validation failure, an array of issue objects describing which fields were wrong.

HTTP status codes

StatusMeaning
200Request succeeded.
401API key missing, malformed, or revoked.
403Request body failed validation. Check the errors array.
404The requested resource (e.g. a qodeJobId) does not exist or you do not have access to it.
5xxTemporary server-side issue. Safe to retry with exponential backoff.

CV handling

POST /interviews accepts a cv_link that points to the candidate’s CV. Plain HTTPS links and Google Drive sharing links are both supported. If the link can’t be fetched or parsed, the interview is still created — the candidate just won’t have a parsed CV profile.

Idempotency

POST /interviews is not idempotent. Calling it twice with the same payload creates two interviews. If you need at-most-once semantics, dedupe on your side before calling.