Vijil evaluation-results API
The evaluation-results API from Vijil — 4 operation(s) for evaluation-results.
OpenAPI Specification
openapi: 3.1.0
info:
title: Vijil Console API (Combined) agent-configurations evaluation-results API
description: Combined OpenAPI specification for all vijil-console microservices.
version: 0.1.0
tags:
- name: evaluation-results
paths:
/v1/evaluation-results/:
get:
tags:
- evaluation-results
summary: List Completed Evaluations
description: "List completed evaluations from S3 storage for a specific team.\n\nThis endpoint lists only completed evaluations that have results stored in S3.\nIt requires the team_id as a query parameter and respects permission checks.\nSupports paging via limit (default 10) and offset.\n\nArgs:\n team_id: Team ID to list evaluations for (required query parameter)\n limit: Max number of results (default 10, max 100)\n offset: Number of results to skip for paging\n claims: JWT claims with user and team info\n diamond_domain: Diamond domain for listing evaluations (newest-first sort + paginate)\n agent_adapter: Agent registry adapter for looking up agent names\n\nReturns:\n List of completed evaluations with evaluation_id, team_id, agent information, and total count\n\nRaises:\n HTTPException: 401 if unauthorized, 403 if no permission"
operationId: list_completed_evaluations_v1_evaluation_results__get
parameters:
- name: team_id
in: query
required: true
schema:
type: string
format: uuid
title: Team Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Maximum number of results to return
default: 10
title: Limit
description: Maximum number of results to return
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Number of results to skip for paging
default: 0
title: Offset
description: Number of results to skip for paging
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluationListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/evaluation-results/{evaluation_id}/results:
get:
tags:
- evaluation-results
summary: Get Evaluation Results
description: "Get evaluation results from S3 storage.\n\nThe results are saved to S3 after the evaluation job completes.\nThis endpoint searches S3 directly (no repository dependency).\n\nArgs:\n evaluation_id: UUID of the evaluation\n team_id: Team ID that owns this evaluation (required query parameter)\n claims: JWT claims with user and team info\n diamond_domain: Diamond domain orchestrator (not used, kept for API consistency)\n storage: Evaluation storage adapter\n\nReturns:\n Evaluation results as JSON\n\nRaises:\n HTTPException: 404 if not found, 403 if no permission"
operationId: get_evaluation_results_v1_evaluation_results__evaluation_id__results_get
parameters:
- name: evaluation_id
in: path
required: true
schema:
type: string
format: uuid
title: Evaluation Id
- name: team_id
in: query
required: true
schema:
type: string
format: uuid
description: Team ID that owns this evaluation
title: Team Id
description: Team ID that owns this evaluation
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Evaluation Results V1 Evaluation Results Evaluation Id Results Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/evaluation-results/{evaluation_id}/report:
get:
tags:
- evaluation-results
summary: Get Evaluation Report
description: "Download evaluation report PDF from S3 storage.\n\nThe report is saved to S3 after the evaluation job completes.\nThis endpoint searches S3 directly (no repository dependency).\n\nArgs:\n evaluation_id: UUID of the evaluation\n team_id: Team ID that owns this evaluation (required query parameter)\n claims: JWT claims with user and team info\n diamond_domain: Diamond domain orchestrator (not used, kept for API consistency)\n storage: Evaluation storage adapter\n\nReturns:\n PDF file response\n\nRaises:\n HTTPException: 404 if report not found in storage, 403 if no permission"
operationId: get_evaluation_report_v1_evaluation_results__evaluation_id__report_get
parameters:
- name: evaluation_id
in: path
required: true
schema:
type: string
format: uuid
title: Evaluation Id
- name: team_id
in: query
required: true
schema:
type: string
format: uuid
description: Team ID that owns this evaluation
title: Team Id
description: Team ID that owns this evaluation
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/evaluation-results/{evaluation_id}/report.html:
get:
tags:
- evaluation-results
summary: Get Evaluation Report Html
description: "Download evaluation report HTML from S3 storage.\n\nThe HTML report is saved to S3 after the evaluation job completes.\nThis is the preferred report format - can be viewed in browser or printed to PDF.\n\nArgs:\n evaluation_id: UUID of the evaluation\n team_id: Team ID that owns this evaluation (required query parameter)\n claims: JWT claims with user and team info\n diamond_domain: Diamond domain orchestrator (not used, kept for API consistency)\n storage: Evaluation storage adapter\n\nReturns:\n HTML file response\n\nRaises:\n HTTPException: 404 if report not found in storage, 403 if no permission"
operationId: get_evaluation_report_html_v1_evaluation_results__evaluation_id__report_html_get
parameters:
- name: evaluation_id
in: path
required: true
schema:
type: string
format: uuid
title: Evaluation Id
- name: team_id
in: query
required: true
schema:
type: string
format: uuid
description: Team ID that owns this evaluation
title: Team Id
description: Team ID that owns this evaluation
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
EvaluationListResponse:
properties:
results:
items:
$ref: '#/components/schemas/EvaluationListItem'
type: array
title: Results
description: List of completed evaluations with results in S3 (current page)
total:
type: integer
title: Total
description: Total number of completed evaluations (before limit/offset)
type: object
required:
- total
title: EvaluationListResponse
description: "Response model for listing completed evaluations.\n "
EvaluationListItem:
properties:
evaluation_id:
type: string
format: uuid
title: Evaluation Id
description: Evaluation ID
team_id:
type: string
format: uuid
title: Team Id
description: Team ID that owns this evaluation
created_by:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Created By
description: User ID who created this evaluation
created_at:
anyOf:
- type: integer
- type: 'null'
title: Created At
description: Unix timestamp when the evaluation was created
completed_at:
anyOf:
- type: integer
- type: 'null'
title: Completed At
description: Unix timestamp when the evaluation completed (from S3 metadata, no file read)
agent_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Agent Id
description: Agent ID that was evaluated
agent_name:
anyOf:
- type: string
- type: 'null'
title: Agent Name
description: Name of the agent that was evaluated
type: object
required:
- evaluation_id
- team_id
title: EvaluationListItem
description: Item in the list of completed evaluations.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError