v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
AI

Gets a list of AI audits.

Retrieves a paginated list of AI audit records for the authenticated customer.

get/aiaudits

Query parameters

page_sizeinteger
Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

aicall_idstring uuid

Filter by AI call ID.

ai_idstring uuid

Filter by AI ID.

Response

A list of AI audits.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "aicall_id": "550e8400-e29b-41d4-a716-446655440000",
      "ai_id": "550e8400-e29b-41d4-a716-446655440000",
      "prompt_history_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "progressing",
      "overall_score": 4,
      "evaluation": {
        "overall_score": 4,
        "dimensions": {
          "helpfulness": {
            "score": 4,
            "reason": "Provided clear and helpful answers."
          },
          "accuracy": {
            "score": 4,
            "reason": "Responses were factually correct."
          },
          "tone": {
            "score": 5,
            "reason": "Maintained professional and empathetic tone."
          },
          "goal_completion": {
            "score": 4,
            "reason": "Successfully resolved the customer's issue."
          },
          "tool_usage": null
        },
        "summary": "The AI assistant performed well overall."
      },
      "message_ids": [
        "550e8400-e29b-41d4-a716-446655440001",
        "550e8400-e29b-41d4-a716-446655440002"
      ],
      "language": "en-US",
      "error": "LLM API quota exceeded",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}