# Get Eval

**GET /v2/evals/{eval_uuid}**

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}


## Servers
- Production server (uses live data): https://api.aymara.ai (Production server (uses live data))
- Staging server (uses test data): https://staging-api.aymara.ai (Staging server (uses test data))


## Authentication methods
- Api key
- Auth bearer


## Parameters

### Path parameters
- **eval_uuid** (string)


### Query parameters
- **workspace_uuid** (string)



## Responses
### 200
OK

#### Body: application/json (object)
- **eval_uuid** (string | null)
  Unique identifier for the evaluation.
- **name** (string | null)
  Name of the evaluation.
- **ai_description** (string)
  Description of the AI under evaluation.
- **ai_instructions** (string | null)
  Instructions the AI should follow.
- **eval_type** (string)
  Type of the eval (safety, accuracy, etc.)
- **eval_instructions** (string | null)
  Additional instructions for the eval, if any.
- **language** (string | null)
  Language code for the eval (default: "en").
- **modality** (string)
  Modality of the eval (e.g., text, image).
- **ground_truth** (string | null | object)
  Ground truth data or reference file, if any.
- **num_prompts** (integer | null)
  Number of prompts/questions in the eval (default: 50).
- **prompt_examples** (array[object] | null)
  List of example prompts for the eval.
- **is_jailbreak** (boolean)
  Indicates if the eval is a jailbreak test.
- **is_sandbox** (boolean)
  Indicates if the eval results are sandboxed.
- **workspace_uuid** (string | null)
  UUID of the associated workspace, if any.
- **status** (string | null)
  Status of the eval.
- **created_at** (string(date-time) | null)
  Timestamp when the eval was created.
- **updated_at** (string(date-time) | null)
  Timestamp when the eval was last updated.

### 400
Bad Request

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 401
Unauthorized

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 403
Forbidden

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 404
Not Found

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 409
Conflict

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 422
Unprocessable Entity

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 429
Too Many Requests

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 500
Internal Server Error

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 503
Service Unavailable

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)



[Powered by Bump.sh](https://bump.sh)