Get Eval Prompts

GET /v2/evals/{eval_uuid}/prompts

Retrieve prompts for a specific eval if they exist.

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

Returns: list[EvalPrompt]: List of prompts and metadata for the eval.

Raises: AymaraAPIError: If the eval is not found.

Example: GET /api/evals/{eval_uuid}/prompts

Path parameters

eval_uuid string Required

Query parameters

workspace_uuid string
limit integer

Minimum value is 1. Default value is 100.
offset integer

Minimum value is 0. Default value is 0.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  prompt_uuid string Required
  
  Unique identifier for the prompt.
  
  thread_uuid string | null
  
  turn_number integer
  
  Turn number in the conversation (default: 1).
  
  Default value is 1.
  
  content string Required
  
  Content of the prompt.
  
  category string | null
- count integer Required
400 application/json

Bad Request
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
403 application/json

Forbidden
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
404 application/json

Not Found
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
409 application/json

Conflict
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
422 application/json

Unprocessable Entity
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
429 application/json

Too Many Requests
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.
503 application/json

Service Unavailable
Hide response attributes Show response attributes object
- error object Required
  
  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.
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Enumeration of all error codes used in the API.
  
  Values are auth.invalid_key, auth.expired_key, auth.insufficient_permissions, validation.invalid_request, validation.invalid_format, resource.not_found, resource.conflict, quota.limit_exceeded, or server.internal_error.
  
  message string Required
  
  details object
  
  Default value is {} (empty).
- request_id string
  
  Default value is empty.

GET /v2/evals/{eval_uuid}/prompts

import os
from aymara_ai import AymaraAI

client = AymaraAI(
    api_key=os.environ.get("AYMARA_AI_API_KEY"),  # This is the default and can be omitted
)
page = client.evals.list_prompts(
    eval_uuid="eval_uuid",
)
page = page.items[0]
print(page.prompt_uuid)

curl \
 --request GET 'https://api.aymara.ai/v2/evals/{eval_uuid}/prompts' \
 --header "x-api-key: $API_KEY"

Response examples (200)

{
  "items": [
    {
      "prompt_uuid": "string",
      "thread_uuid": "string",
      "turn_number": 1,
      "content": "string",
      "category": "string"
    }
  ],
  "count": 42
}

Response examples (400)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (401)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (403)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (404)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (409)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (422)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (429)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (500)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}

Response examples (503)

{
  "error": {
    "code": "auth.invalid_key",
    "message": "string",
    "details": {}
  },
  "request_id": ""
}