> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create annotations annotations > Requires scopes: eval:write ## OpenAPI ````yaml /api-reference/openapi.json post /api/annotations openapi: 3.1.2 info: title: EvalGate API version: 18.7.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 security: [] paths: /api/annotations: post: tags: - annotations summary: Create annotations annotations description: 'Requires scopes: eval:write' operationId: post_annotations requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiAnnotationsRequest' responses: '201': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiAnnotationsResponse201ApplicationJson '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: [] components: schemas: PostApiAnnotationsRequest: type: object properties: evaluationRunId: type: number testCaseId: type: number metadata: allOf: - type: object properties: annotatorExperience: type: string timeSpentMs: type: number labelTaxonomyVersion: type: string reviewerConfidence: type: number adjudicationStatus: oneOf: - type: string enum: - pending - type: string enum: - resolved - type: string enum: - unreviewed evidenceSummary: type: array items: oneOf: - type: string enum: - trajectory - type: string enum: - input - type: string enum: - output - type: string enum: - expected_output - type: string enum: - messages - type: string enum: - tool_calls - type: string enum: - assertion_result - type: string enum: - human_feedback additionalProperties: false - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' labels: allOf: - type: object properties: tags: type: array items: type: string taxonomyVersion: type: string assertionLabels: type: array items: type: object properties: verdict: oneOf: - type: string enum: - rejected - type: string enum: - not_applicable - type: string enum: - confirmed - type: string enum: - uncertain assertionKey: oneOf: - type: string enum: - safety - type: string enum: - pii - type: string enum: - hallucination - type: string enum: - toxicity - type: string enum: - instruction_following - type: string enum: - json_schema - type: string enum: - readability - type: string enum: - functional - type: string enum: - judge severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low evidence: type: array items: oneOf: - type: string enum: - trajectory - type: string enum: - input - type: string enum: - output - type: string enum: - expected_output - type: string enum: - messages - type: string enum: - tool_calls - type: string enum: - assertion_result - type: string enum: - human_feedback notes: type: string additionalProperties: false required: - verdict - assertionKey failureModes: type: array items: type: string calibrationLabel: oneOf: - type: string enum: - standard - type: string enum: - gold - type: string enum: - adjudication additionalProperties: false - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' taskId: type: number rating: type: number feedback: type: string additionalProperties: false required: - evaluationRunId - testCaseId PostApiAnnotationsResponse201ApplicationJson: type: object properties: annotation: type: object properties: id: type: number createdAt: type: string format: date-time metadata: oneOf: - type: 'null' - type: object properties: annotatorExperience: type: string timeSpentMs: type: number labelTaxonomyVersion: type: string reviewerConfidence: type: number adjudicationStatus: oneOf: - type: string enum: - pending - type: string enum: - resolved - type: string enum: - unreviewed evidenceSummary: type: array items: oneOf: - type: string enum: - trajectory - type: string enum: - input - type: string enum: - output - type: string enum: - expected_output - type: string enum: - messages - type: string enum: - tool_calls - type: string enum: - assertion_result - type: string enum: - human_feedback additionalProperties: false evaluationRunId: type: number testCaseId: type: number labels: oneOf: - type: 'null' - type: object properties: assertionLabels: type: array items: type: object properties: assertionKey: oneOf: - type: string enum: - safety - type: string enum: - pii - type: string enum: - hallucination - type: string enum: - toxicity - type: string enum: - instruction_following - type: string enum: - json_schema - type: string enum: - readability - type: string enum: - functional - type: string enum: - judge verdict: oneOf: - type: string enum: - rejected - type: string enum: - not_applicable - type: string enum: - confirmed - type: string enum: - uncertain evidence: type: array items: oneOf: - type: string enum: - trajectory - type: string enum: - input - type: string enum: - output - type: string enum: - expected_output - type: string enum: - messages - type: string enum: - tool_calls - type: string enum: - assertion_result - type: string enum: - human_feedback severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low notes: type: string additionalProperties: false required: - assertionKey - verdict - evidence calibrationLabel: oneOf: - type: string enum: - standard - type: string enum: - gold - type: string enum: - adjudication taxonomyVersion: type: string failureModes: type: array items: type: string tags: type: array items: type: string legacyLabels: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - assertionLabels - taxonomyVersion annotatorId: type: string rating: oneOf: - type: 'null' - type: number feedback: oneOf: - type: 'null' - type: string additionalProperties: false required: - id - createdAt - metadata - evaluationRunId - testCaseId - labels - annotatorId - rating - feedback additionalProperties: false required: - annotation JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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 responses: 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 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 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 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 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 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 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 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 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.