Eval APIs
Read the traces and scores behind your tenant's LLM turns, curate evaluation datasets, and record what an eval harness measured.
These are observability and evaluation APIs, not agent tools. Every operation is scoped to the authenticated tenant — there is no field on any request that names a tenant, a user, or a rater, because that identity is taken from your credentials and nothing else.
All operations are POST /api/v1/evals/<method> with a JSON request body.
Authentication
Send a tenant-scoped API key in X-API-Key. No user identity is required or accepted: this API is built for machine callers — an eval harness, or your own tooling — which authenticate as a tenant rather than as a person. Where a human reviewer's identity matters, it is taken from the caller's credentials, so a score recorded through a user JWT is attributed and one recorded by a harness is not. Neither can claim to be the other.
Projects
An optional X-Project-Id request header selects the sub-tenant project to read and write. It defaults to default, which is the only project until multi-project support ships. It is not an authentication header — your key still determines which tenant you are.
If the tenant and project you address has no evaluation backend provisioned, calls fail with HTTP 424 and a message naming the tenant and project. That is a provisioning gap, not a bad request; retrying will not help.
Reading responses
Several read operations return contentRedacted. When it is true the returned text has been redacted and differs from what the conversation store holds — render it accordingly rather than presenting it as verbatim.
Note that 64-bit integer fields are encoded as JSON strings, per the protobuf JSON mapping.
Pagination
List operations take page (1-based) and pageSize, and return a page object carrying totalItems and totalPages. There is no cursor.
Authentication
- API Key: apiKeyAuth
Your tenant-scoped API key. sk_… for backend-to-backend calls.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |