> For the complete documentation index, see [llms.txt](https://helpcenter.talentlead.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpcenter.talentlead.nl/talent-assessment/api.md).

# API

Met de publieke REST API koppel je Talent Assessment aan je ATS, HR-systeem of eigen tooling. Alles wat je in het dashboard kunt, kan (stapsgewijs) ook via de API. De eerste versie richt zich op de complete ATS-flow:

```mermaid
flowchart LR
    A["Persoon importeren\nPOST /persons"] --> B["Uitnodigen\nPOST /invitations"]
    B --> C["Kandidaat doet\nassessment"]
    C --> D["Webhook\nassessment.completed"]
    D --> E["Resultaten & matches\nGET /persons/{id}/..."]
```

#### In het kort

|                    |                                                                                                                                    |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| **Base URL**       | `https://assessment.talentlead.nl`                                                                                                 |
| **Authenticatie**  | API-sleutel via `Authorization: Bearer tl_live_...`                                                                                |
| **Beschikbaar op** | Professional (60 req/min) en Business (300 req/min)                                                                                |
| **Formaat**        | JSON, cursor-paginatie, Engelstalige foutcodes                                                                                     |
| **Spec**           | [OpenAPI 3.1](https://assessment.talentlead.nl/api/openapi.json) · [interactieve referentie](https://assessment.talentlead.nl/api) |

#### Aan de slag

1. Maak een API-sleutel aan onder **Beheer → API** in het dashboard. Kies de scopes die je integratie nodig heeft.
2. Test je sleutel:

```bash
curl https://assessment.talentlead.nl/api/v1/me \
  -H "Authorization: Bearer tl_live_..."
```

3. Lees verder bij Authenticatie & scopes en de API-referentie.

{% hint style="info" %}
**Toekomstvast:** API-toegang is op gebruikersniveau. Ondersteuning voor OAuth en MCP (zodat AI-assistenten namens een gebruiker kunnen werken) staat op de roadmap en gebruikt dezelfde scopes.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://helpcenter.talentlead.nl/talent-assessment/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.