v25

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-204973358.2 KB

Evals

Get Eval

Retrieve a specific eval by its UUID.

Args: eval_uuid (str): UUID of the eval to retrieve. workspace_uuid (str, optional): Optional workspace UUID for filtering.

Returns: Eval: The eval data.

Raises: AymaraAPIError: If the eval is not found.

Example: GET /api/evals/{eval_uuid}

get/v2/evals/{eval_uuid}

eval_uuidstring required

workspace_uuidstring

eval_uuidstring nullable

Unique identifier for the evaluation.

namestring nullable

Name of the evaluation.

created_bystring nullable

Name of the user who created the evaluation.

ai_descriptionstring required

Description of the AI under evaluation.

eval_typestring required

Type of the eval (safety, accuracy, etc.)

eval_instructionsstring nullable

Additional instructions for the eval, if any.

languagestring nullable

Language code for the eval (default: "en").

modality'text' | 'image' | 'video'

Content type for AI interactions.

num_promptsinteger nullable

Number of prompts/questions in the eval (default: 50).

is_jailbreakboolean

Indicates if the eval is a jailbreak test.

is_sandboxboolean

Indicates if the eval results are sandboxed.

workspace_uuidstring nullable

UUID of the associated workspace, if any.

status'created' | 'processing' | 'finished' | 'failed'

Resource status.

created_atstring date-time nullable

Timestamp when the eval was created.

updated_atstring date-time nullable

Timestamp when the eval was last updated.