# Run Eval

**POST /v2/eval-runs/-/score-responses**

Run the eval with the provided responses.

Args:
    eval_run_data (EvalRunRequest): Data for the eval run, including responses.
    workspace_uuid (str, optional): UUID of the workspace. Defaults to None.
    is_sandbox (bool, optional): Whether to run in sandbox mode. Defaults to False.

Returns:
    EvalRunResult: The result of the eval run after scoring the responses.

Raises:
    AymaraAPIError: If the organization is missing or the request is invalid.

Example:
    POST /api/eval-runs/-/score-responses
    {
        "eval_uuid": "...",
        "responses": [...]
    }


## 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


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

- **is_sandbox** (boolean)


### Body: application/json (object)

- **eval_uuid** (string)
  Unique identifier for the eval.
- **eval_run_uuid** (string | null)
  Unique identifier for the eval run, if any.
- **name** (string | null)
  Name of the eval run, if any (defaults to the eval name + timestamp).
- **ai_description** (string | null)
  Description of the AI for this run, if any.
- **continue_thread** (boolean | null)
  Whether to continue the thread after this run.
- **eval_run_examples** (array[object] | null)
  Examples to include with the eval run, if any.
- **responses** (array[object])
  List of AI responses to eval prompts.


## Responses
### 200
OK

#### Body: application/json (object)
- **eval_run_uuid** (string)
  Unique identifier for the eval run.
- **eval_uuid** (string)
  Unique identifier for the eval.
- **name** (string | null)
  Name of the eval run, if any (defaults to the eval name + timestamp).
- **status** (string)
  Resource status.
- **created_at** (string(date-time))
  Timestamp when the eval run was created.
- **updated_at** (string(date-time))
  Timestamp when the eval run was last updated.
- **evaluation** (object | null)
  Eval configuration used for this run, if any.
- **ai_description** (string | null)
  Description of the AI for this run, if any.
- **workspace_uuid** (string | null)
  UUID of the associated workspace, if any.
- **pass_rate** (number | null)
  Pass rate for the eval run, if any.
- **num_prompts** (integer | null)
  Number of prompts in the eval run, if any.
- **num_responses_scored** (integer | null)
  Number of responses scored in the eval run, if any.
- **responses** (array[object] | null)
  List of scored responses for the eval run, if any.

### 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)