Query parameters

• workspace_uuid string
• is_sandbox boolean | null

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • eval_suite_report_uuid string Required

    Unique identifier for the eval suite report.

  • status string Required

    Resource status.

    Values are created, processing, finished, or failed.

  • eval_run_reports array[object] Required

    List of eval run reports included in the suite.

    Hide eval_run_reports attributes Show eval_run_reports attributes object

    • eval_run_report_uuid string Required

      Unique identifier for the eval run report.

    • eval_run_uuid string Required

      Unique identifier for the eval run.

    • eval_run object Required

      Schema for returning eval run data.

      Hide eval_run attributes Show eval_run attributes object

      • eval_run_uuid string Required

        Unique identifier for the eval run.

      • eval_uuid string Required

        Unique identifier for the eval.

      • name string | null
      • status string Required

        Resource status.

        Values are created, processing, finished, or failed.

      • created_at string(date-time) Required

        Timestamp when the eval run was created.

      • updated_at string(date-time) Required

        Timestamp when the eval run was last updated.

      • evaluation object | null

        Schema for configuring an Eval based on a eval_type.

        Hide evaluation attributes Show evaluation attributes object | null

        • eval_uuid string | null
        • name string | null
        • ai_description string Required

          Description of the AI under evaluation.

        • ai_instructions string | null
        • eval_type string Required

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

        • eval_instructions string | null
        • language string | null

          Default value is en.

        • modality string

          Content type for AI interactions.

          Values are text or image. Default value is text.

        • ground_truth string | null | object

          Ground truth data or reference file, if any.

          Any of:

          string-1 string | null FileReference object | null

          Hide attribute Show attribute

          • remote_file_path string | null
        • num_prompts integer | null

          Default value is 100.

        • prompt_examples array[object] | null
          Hide prompt_examples attributes Show prompt_examples attributes object

          • content string Required

            Content of the example prompt.

          • example_uuid string | null
          • type string

            Values are good or bad. Default value is good.

          • explanation string | null
        • is_jailbreak boolean

          Indicates if the eval is a jailbreak test.

          Default value is false.

        • is_sandbox boolean

          Indicates if the eval results are sandboxed.

          Default value is false.

        • workspace_uuid string | null
        • status string | null

          Resource status.

          Values are created, processing, finished, or failed.

        • created_at string(date-time) | null
        • updated_at string(date-time) | null
      • ai_description string | null
      • workspace_uuid string | null
      • pass_rate number | null
      • num_prompts integer | null
      • num_responses_scored integer | null
      • responses array[object] | null

        Schema for returning AI response data.

        Hide responses attributes Show responses 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.

        • continue_thread boolean

          Whether to continue the thread after this response.

          Default value is false.

        • content string | null | object

          Content of the AI response or a file reference.

          Any of:

          string-1 string | null FileReference object | null

          Hide attribute Show attribute

          • remote_file_path string | null
        • content_type string

          Content type for AI interactions.

          Values are text or image. Default value is text.

        • exclude_from_scoring boolean

          Whether to exclude this response from scoring.

          Default value is false.

        • ai_refused boolean

          Whether the AI refused to answer the prompt.

          Default value is false.

        • response_uuid string | null
        • explanation string | null
        • confidence number | null
        • is_passed boolean | null
        • next_prompt object | null
          Hide next_prompt attributes Show next_prompt attributes object | null

          • 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
    • passing_responses_summary string Required

      Summary of passing responses.

    • failing_responses_summary string Required

      Summary of failing responses.

    • improvement_advice string Required

      Advice for improving future responses.

  • overall_improvement_advice string | null
  • overall_failing_responses_summary string | null
  • overall_passing_responses_summary string | null
  • created_at string(date-time) Required

    Timestamp when the eval suite report was created.

  • updated_at string(date-time) Required

    Timestamp when the eval suite report was last updated.

  • remaining_reports integer | null
• 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.