Client SDKs

The API is plain REST described by an OpenAPI 3.1 document, so you generate a typed client for your language in one command rather than depending on a hand-written SDK release cycle.

https://api.curriculo.me/public/openapi.json

The specification covers the synchronous operations and the background task endpoints. The screening interview endpoints are not in it yet; call them directly.

Generate a typed client from the spec

TypeScript:

npx @hey-api/openapi-ts -i https://api.curriculo.me/public/openapi.json -o src/curriculo-client

Python:

openapi-generator-cli generate -i https://api.curriculo.me/public/openapi.json \
  -g python -o ./curriculo-client

What every client must do

• Send Authorization: Bearer <credential> on every call.
• Keep a request timeout above five minutes for the document operations.
• Retry 429 and 503 with backoff.
• Log the X-Curriculo-Request-Id response header.

See Authentication, Rate limits and Errors.

Interactive documentation and Postman

• Swagger UI: run any synchronous operation against production with your own key.
• ReDoc: the same specification, as a readable reference.
• Postman: import the OpenAPI JSON above, or a cURL request copied from the documentation page in the Developer Console.