EvalGate Reports API
The reports API from EvalGate — 3 operation(s) for reports.
The reports API from EvalGate — 3 operation(s) for reports.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/evalgate-com:evalgate-com-reports-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: EvalGate Reports API
version: 18.13.0
description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
- url: https://evalgate.com
description: Production
- url: http://localhost:3000
description: Local
tags:
- name: Reports
paths:
/api/reports/{shareToken}/revoke:
post:
x-evalgate-source-hash: sha256:d3dd9170dd46b34b15294dd41cc2122a4459ea4cb68cf38f19c0437ab31ffdf9
summary: Create reports revoke
operationId: post_reports_shareToken_revoke
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PostApiReportsShareTokenRevokeResponse200ApplicationJson'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
security:
- bearerAuth: []
tags:
- Reports
x-evalgate-request-validators:
- revokeReportBodySchema
x-evalgate-required-scopes:
- reports:write
parameters:
- name: shareToken
in: path
required: true
schema:
type: string
description: 'Requires scopes: reports:write'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostApiReportsShareTokenRevokeRequest'
x-evalgate-contract-hash: sha256:212d8174964f62c51478cc3f37056b4059280d62b7beddf2175ac2115a2b5cf4
/api/reports/{shareToken}/verify:
get:
x-evalgate-source-hash: sha256:52799e88532a099c676702ea7f81f52728e06069a706cd8638ab41728f5c0093
summary: Get reports verify
operationId: get_reports_shareToken_verify
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiReportsShareTokenVerifyResponse200ApplicationJson'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
security:
- bearerAuth: []
tags:
- Reports
x-evalgate-required-scopes:
- runs:read
parameters:
- name: shareToken
in: path
required: true
schema:
type: string
description: 'Requires scopes: runs:read'
x-evalgate-contract-hash: sha256:1c98c7c771b047e972274f2f21a0b88ce19db87cd8eb9aba90596ead45d96892
/api/reports:
get:
x-evalgate-source-hash: sha256:06df1d40972d3e2d35aafed2b9157ab1847634c650c87e4b04e0fc9c5ebd0b69
summary: List reports reports
operationId: get_reports
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiReportsResponse200ApplicationJson'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
security:
- bearerAuth: []
tags:
- Reports
x-evalgate-required-scopes:
- runs:read
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 1000
default: 50
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
description: 'Requires scopes: runs:read'
x-evalgate-contract-hash: sha256:c9fef3a405348610f0152c602099e6bf7f7381011e456a504a74a1439d707347
post:
x-evalgate-source-hash: sha256:6f149573d240a07e27c1b1e924ff0feffcdd75d3a1407d8cac91d0d0392b92d7
summary: Create reports reports
operationId: post_reports
responses:
'201':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PostApiReportsResponse201ApplicationJson'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
security:
- bearerAuth: []
tags:
- Reports
x-evalgate-request-validators:
- createReportBodySchema
x-evalgate-required-scopes:
- reports:write
description: 'Requires scopes: reports:write'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostApiReportsRequest'
x-evalgate-contract-hash: sha256:04b9947dccef57eee267796444f461e2d20b7eb1fd4b52eada9d33690adac385
components:
schemas:
OrganizationId:
type: string
format: uuid
GetApiReportsShareTokenVerifyResponse200ApplicationJson:
type: object
properties:
verified:
type: boolean
enum:
- true
reportId:
type: number
shareToken:
type: string
organizationId:
$ref: '#/components/schemas/OrganizationId'
evaluationId:
type: number
evaluationRunId:
type: number
signingKeyVersion:
type: number
signatureAlgorithm:
type: string
enum:
- hmac-sha256-v1
audience:
type: string
scope:
type: string
replayPolicy:
oneOf:
- type: string
enum:
- reusable
- type: string
enum:
- one_time
redactionApplied:
type: boolean
redactionPolicyVersion:
type: string
viewCount:
type: number
createdAt:
type: string
format: date-time
expiresAt:
oneOf:
- type: 'null'
- type: string
format: date-time
revokedAt:
type: 'null'
additionalProperties: false
required:
- verified
- reportId
- shareToken
- organizationId
- evaluationId
- evaluationRunId
- signingKeyVersion
- signatureAlgorithm
- audience
- scope
- replayPolicy
- redactionApplied
- redactionPolicyVersion
- viewCount
- createdAt
- expiresAt
- revokedAt
PostApiReportsResponse201ApplicationJson:
type: object
properties:
id:
type: number
shareToken:
type: string
shareUrl:
type: string
apiUrl:
type: string
expiresAt:
oneOf:
- type: 'null'
- type: string
format: date-time
signingKeyVersion:
type: number
additionalProperties: false
required:
- id
- shareToken
- shareUrl
- apiUrl
- expiresAt
- signingKeyVersion
PostApiReportsShareTokenRevokeRequest:
type: object
properties:
reason:
type: string
additionalProperties: false
ApiError:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- INVALID_REFERENCE
- VALIDATION_ERROR
- RATE_LIMITED
- CONFLICT
- INTERNAL_ERROR
- SERVICE_UNAVAILABLE
- QUOTA_EXCEEDED
- FEATURE_LIMIT_REACHED
- NO_ORG_MEMBERSHIP
- SHARE_REVOKED
- SHARE_EXPIRED
- SHARE_UNAVAILABLE
- PROVIDER_KEY_MISSING
- PROVIDER_KEY_EXPIRED
- PROVIDER_RATE_LIMITED
- PROVIDER_UNAUTHORIZED
- PROVIDER_UNAVAILABLE
- AGENT_HANDOFF_INVALID
- AGENT_HANDOFF_EXPIRED
- AGENT_HANDOFF_DENIED
- AGENT_HANDOFF_CONSUMED
- PAYLOAD_TOO_LARGE
- METHOD_NOT_ALLOWED
message:
type: string
details: {}
requestId:
type: string
format: uuid
redaction:
type: object
properties:
applied:
type: boolean
enum:
- true
fieldCount:
type: integer
minimum: 0
secretCount:
type: integer
minimum: 0
required:
- applied
- fieldCount
- secretCount
required:
- code
- message
required:
- error
PostApiReportsShareTokenRevokeResponse200ApplicationJson:
type: object
properties:
success:
type: boolean
enum:
- true
revoked:
type: boolean
enum:
- true
alreadyRevoked:
type: boolean
revokedAt:
type: string
format: date-time
additionalProperties: false
required:
- success
- revoked
- alreadyRevoked
- revokedAt
GetApiReportsResponse200ApplicationJson:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: number
organizationId:
$ref: '#/components/schemas/OrganizationId'
evaluationId:
type: number
evaluationRunId:
type: number
shareToken:
type: string
reportBody:
type: string
signature:
type: string
signingKeyVersion:
type: number
audience:
type: string
scope:
type: string
redactionPolicyVersion:
type: string
redactionApplied:
type: boolean
redactionFieldCount:
type: number
redactionSecretCount:
type: number
replayPolicy:
oneOf:
- type: string
enum:
- reusable
- type: string
enum:
- one_time
consumedAt:
oneOf:
- type: 'null'
- type: string
format: date-time
expiresAt:
oneOf:
- type: 'null'
- type: string
format: date-time
revokedAt:
oneOf:
- type: 'null'
- type: string
format: date-time
revokedBy:
oneOf:
- type: 'null'
- type: string
revokedReason:
oneOf:
- type: 'null'
- type: string
viewCount:
oneOf:
- type: 'null'
- type: number
createdBy:
type: string
createdAt:
type: string
format: date-time
additionalProperties: false
required:
- id
- organizationId
- evaluationId
- evaluationRunId
- shareToken
- reportBody
- signature
- signingKeyVersion
- audience
- scope
- redactionPolicyVersion
- redactionApplied
- redactionFieldCount
- redactionSecretCount
- replayPolicy
- consumedAt
- expiresAt
- revokedAt
- revokedBy
- revokedReason
- viewCount
- createdBy
- createdAt
count:
type: number
additionalProperties: false
required:
- data
- count
PostApiReportsRequest:
type: object
properties:
evaluationId:
type: number
evaluationRunId:
type: number
workflowId:
type: string
replayPolicy:
oneOf:
- type: string
enum:
- reusable
- type: string
enum:
- one_time
expiresInDays:
type: number
policyName:
type: string
additionalProperties: false
required:
- evaluationId
- evaluationRunId
responses:
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
ValidationError:
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
RateLimited:
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
Retry-After:
description: Delay in seconds before retrying when present.
schema:
type: integer
minimum: 1
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
WWW-Authenticate:
description: Bearer challenge. Agent-facing routes include the RFC 9728 resource_metadata URL.
schema:
type: string
ServiceUnavailable:
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
headers:
RateLimit-Limit:
description: Quota in requests for the active window.
schema:
type: integer
minimum: 0
RateLimit-Remaining:
description: Remaining requests in the active window.
schema:
type: integer
minimum: 0
RateLimit-Reset:
description: Reset delay in seconds (not a Unix timestamp).
schema:
type: integer
minimum: 1
X-RateLimit-Limit:
schema:
type: integer
minimum: 0
X-RateLimit-Remaining:
schema:
type: integer
minimum: 0
X-RateLimit-Reset:
description: Legacy reset timestamp in Unix milliseconds.
schema:
type: integer
minimum: 0
RateLimit-Policy:
description: IETF HTTPAPI structured quota policy (work in progress).
schema:
type: string
RateLimit:
description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: EvalGate API key
description: Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
x-evalgate-scopes-supported:
- eval:read
- eval:write
- objectives:read
- objectives:write
- runs:read
- runs:write
- traces:read
- traces:write
- exports:download
- reports:write
- prompt:publish
- scorer:publish
- red_team:read
- red_team:run
- red_team:approve
- docs:read
- agent:read
- agent:execute
- resources:read
- resources:write
- contexts:read
- contexts:write
- observations:write
- checks:read
- checks:run
- standards:read
- standards:write
- standards:approve
- grants:read
- grants:write
- admin:keys
- admin:workspace
- admin:org
x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource
ProviderHealthSignature:
type: apiKey
in: header
name: x-evalgate-provider-health-signature
description: HMAC SHA-256 signature over the exact provider request bytes. Provider requests also require the timestamp and key-id headers.
browserSession:
type: apiKey
in: cookie
name: better-auth.session_token
description: Interactive EvalGate browser session established through GitHub or Google sign-in. This scheme represents the human approval step and is not an agent API key or an EvalGate OAuth authorization-server token.
x-service-info:
categories:
- ai
- developer-tools
docs:
homepage: https://evalgate.com
apiReference: https://docs.evalgate.com/api-reference
llms: https://evalgate.com/llms.txt