Examplary REST API

Integrate with the Examplary AI testing platform through the REST API, allowing you to manage exams, questions, results and users programmatically.

Base URL

All endpoints are available through the HTTP API at:

https://api.examplary.ai

Authentication

To authenticate with the Examplary API, you need to include a credential in the Authorization header of each request — typically your personal API key, obtained from your Examplary account settings.

API keys are always scoped to a specific user and workspace.

Authorization: Bearer YOUR_API_KEY

If you can't set a custom header — for example, a link opened directly in a browser — you can pass the key as a key query parameter instead: ?key=YOUR_API_KEY. Prefer the header wherever possible, since query parameters tend to end up in server logs.

If you're building a third-party integration, you can also authenticate on behalf of your users with an OAuth access token instead of an API key — see Sign in with Examplary. It's used the same way, as a Bearer token in the Authorization header.

Payloads

All request bodies and response payloads are JSON-encoded.

Browser access (CORS)

The API only sends CORS headers to the Examplary dashboard, admin, and marketing origins, plus any org's active custom domain — so calling it directly with an API key or OAuth token from browser JavaScript on another origin will fail. Server-to-server requests are unaffected, since CORS is a browser-only restriction. If you need in-browser access, use Embed Sessions instead of calling the API directly from the client.

Rate limits

Some endpoints are rate limited, per user or per IP address depending on the endpoint — see the "Rate limit" section on each endpoint's reference page to check whether one applies and what it is. Exceeding it returns a 429 response with a Retry-After header.

Example request

PATCH https://api.examplary.ai/me
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
 
{
    "name": "My new name"
}