Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Agenta Evaluations API

Run evaluations of variants against testsets.

Agenta Evaluations API is one of 7 APIs that Agenta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Evaluations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://cloud.agenta.ai/api, https://eu.cloud.agenta.ai/api.

4 operations 4 paths 10 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://cloud.agenta.ai/api
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Agenta Evaluations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Agenta API key sent in the Authorization header. Generate keys from the Agenta web app under Settings API keys. The value is passed as Authorization: ApiKey (B…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Evaluations 4

Run evaluations of variants against testsets.

POST
/evaluations/runs/query
List and filter evaluation runs.
queryEvaluationRuns body → 200401
POST
/evaluations/runs/
Create an evaluation run.
createEvaluationRun body → 200401
POST
/evaluations/results/query
Query evaluation results.
queryEvaluationResults body → 200401
POST
/evaluations/metrics/query
Query aggregated evaluation metrics.
queryEvaluationMetrics body → 200401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EvaluationRun (5 properties), Windowing (5 properties), EvaluationMetrics (5 properties), EvaluationResult (5 properties). Each schema is shown below with its type and property counts.

EvaluationResultQueryRequest
object
2 properties
EvaluationMetricsQueryRequest
object
1 property
EvaluationRun
object
5 properties
EvaluationRunQueryRequest
object
3 properties
EvaluationResult
object
5 properties
Lifecycle
object
Audit metadata attached to most Agenta resources.
4 properties
EvaluationMetrics
object
5 properties
Windowing
object
Cursor / time-window pagination controls.
5 properties
Error
object
1 property
EvaluationRunCreateRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agenta-evaluations-api-openapi.yml Raw ↑

Other APIs Agenta publishes across the network.

Agenta Applications API
Agenta Configs API
Agenta Evaluators API
Agenta OpenTelemetry API
Agenta Testsets API
Agenta Traces API