> ## Documentation Index > Fetch the complete documentation index at: https://mathify.dev/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a single eval pipeline run ## OpenAPI ````yaml /openapi.json get /evals/pipeline-runs/{pipelineRunId} openapi: 3.1.0 info: title: Mathify API version: 1.0.0 description: >- Public REST API for generating and retrieving Mathify math animations. See app/api/v1/README.md in the source repo for the underlying implementation. servers: - url: https://mathify.dev/api/v1 security: [] tags: - name: Projects - name: Messages - name: Fragments - name: Music - name: Evals paths: /evals/pipeline-runs/{pipelineRunId}: get: tags: - Evals summary: Get a single eval pipeline run operationId: getEvalPipelineRun parameters: - in: path name: pipelineRunId schema: type: string required: true - in: query name: includeIssues schema: description: Embed the full issue list on each eval run. type: string enum: - '0' - '1' - 'true' - 'false' description: Embed the full issue list on each eval run. responses: '200': description: Eval pipeline run content: application/json: schema: type: object properties: evalPipelineRun: $ref: '#/components/schemas/EvalPipelineRun' required: - evalPipelineRun additionalProperties: false '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- A valid API key is required, or the account has no credits balance (see https://mathify.dev/pricing) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyHeader: [] - bearerAuth: [] components: schemas: EvalPipelineRun: type: object properties: id: type: string fragmentId: type: string projectId: type: string userId: type: string attemptNumber: type: integer minimum: -9007199254740991 maximum: 9007199254740991 status: $ref: '#/components/schemas/EvalPipelineStatus' overallStatus: anyOf: - $ref: '#/components/schemas/EvalRunStatus' - type: 'null' renderJobId: anyOf: - type: string - type: 'null' executionName: anyOf: - type: string - type: 'null' summary: anyOf: - type: string - type: 'null' createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ startedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ completedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' evalRuns: type: array items: $ref: '#/components/schemas/EvalRun' required: - id - fragmentId - projectId - userId - attemptNumber - status - overallStatus - summary - createdAt - startedAt - completedAt - evalRuns additionalProperties: false ErrorResponse: type: object properties: error: example: Project not found type: string required: - error additionalProperties: false EvalPipelineStatus: example: COMPLETED type: string enum: - PENDING - RUNNING - COMPLETED - ERROR EvalRunStatus: example: PASS type: string enum: - PENDING - RUNNING - PASS - FAIL - ERROR - SKIPPED EvalRun: type: object properties: id: type: string kind: $ref: '#/components/schemas/EvalKind' status: $ref: '#/components/schemas/EvalRunStatus' score: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' maxScore: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' issueCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 highSeverityCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 summary: anyOf: - type: string - type: 'null' provider: anyOf: - type: string - type: 'null' model: anyOf: - type: string - type: 'null' createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ completedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' issues: description: Only present when includeIssues=1 was requested. type: array items: $ref: '#/components/schemas/EvalIssue' required: - id - kind - status - score - maxScore - issueCount - highSeverityCount - summary - provider - model - createdAt - completedAt additionalProperties: false EvalKind: example: VISUAL_RUBRIC_JSON type: string enum: - USER_INPUT_SECURITY - VISUAL_VALIDATION_JSON - DESIGN_VALIDATION_JSON - VISUAL_RUBRIC_JSON - ENGAGEMENT_RUBRIC_JSON EvalIssue: type: object properties: id: type: string severity: $ref: '#/components/schemas/EvalIssueSeverity' category: type: string frameIndex: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' frameHint: anyOf: - type: string - type: 'null' description: type: string suggestedFix: anyOf: - type: string - type: 'null' required: - id - severity - category - frameIndex - frameHint - description - suggestedFix additionalProperties: false EvalIssueSeverity: example: MEDIUM type: string enum: - LOW - MEDIUM - HIGH securitySchemes: apiKeyHeader: type: apiKey in: header name: x-api-key description: >- Your Mathify API key (`mk_live_<64 hex chars>`), generated at /settings/api-keys. bearerAuth: type: http scheme: bearer description: 'Same token as apiKeyHeader, passed as `Authorization: Bearer `.' ````