Getting started

The Skillflare HTTP API lets organizations manage candidates, challenges, environments, and sessions programmatically. A challenge is the assessment primitive: sessions always reference a challenge_id. An environment is a desktop OS image challenges can run on.

Base URL

https://api.skillflare.co

All versioned routes live under /v1. Example:

https://api.skillflare.co/v1/candidates

Health check

curl https://api.skillflare.co/health

{ "status": "ok" }

Resources

Conventions

• Only for partner customers. Pass the active organization with the optional x-organization-id header on candidate, challenge, and session requests. Omit it to use the organization that owns the API key. A partner key may pass a direct child. A non-empty organization_id in the query or body returns 400 VALIDATION_ERROR.
• Single-resource successes return the entity at the top level (no data wrapper).
• List endpoints return { "data": [...], "meta": { "limit", "offset", "count" } }.
• Errors use { "error": "CODE", "message": "..." }. See Errors and pagination.