Sign in
Simulation Runs
Simulation Run Items

List Simulation Run Items

get/eval/simulation/run/{id}/item

Path parameters

idstring uuid required

The unique identifier for the resource.

Query parameters

simulationIdstring uuid

This is the simulation ID to filter by.

runIdstring uuid

This is the run ID (batch/group) to filter by.

status'queued' | 'running' | 'evaluating' | 'passed' | 'failed' | 'canceled'

This is the status to filter by.

pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

sortBy'createdAt' | 'duration' | 'cost'

This is the column to sort by. Defaults to 'createdAt'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

idstring uuid required

This is the unique identifier for the simulation run item.

orgIdstring uuid required

This is the unique identifier for the organization.

simulationIdstring uuid required

This is the ID of the simulation this run belongs to.

status'queued' | 'running' | 'evaluating' | 'passed' | 'failed' | 'canceled' required

This is the current status of the run.

queuedAtstring date-time required

This is the ISO 8601 date-time string of when the run was queued.

startedAtstring date-time

This is the ISO 8601 date-time string of when the run started.

completedAtstring date-time

This is the ISO 8601 date-time string of when the run completed.

failedAtstring date-time

This is the ISO 8601 date-time string of when the run failed.

canceledAtstring date-time

This is the ISO 8601 date-time string of when the run was canceled.

failureReasonstring

This is the reason for failure.

callIdstring uuid

This is the ID of the target Vapi call (the assistant being tested).

createdAtstring date-time required

This is the ISO 8601 date-time string of when the run item was created.

updatedAtstring date-time required

This is the ISO 8601 date-time string of when the run item was last updated.

runIdstring uuid

This is the ID of the parent run (batch/group).

iterationNumbernumber

This is the iteration number (1-indexed) when run with iterations > 1.

sessionIdstring uuid

This is the session ID for chat-based simulations (webchat transport).

scenarioIdstring uuid

This is the scenario ID at run creation time.

personalityIdstring uuid

This is the personality ID at run creation time.

Example response

[
  {
    "hooks": [
      {
        "do": [
          {
            "server": {
              "timeoutSeconds": 20,
              "credentialId": "550e8400-e29b-41d4-a716-446655440000",
              "backoffPlan": {
                "baseDelaySeconds": 1,
                "excludedStatusCodes": [
                  400,
                  401,
                  403,
                  404
                ]
              }
            }
          }
        ]
      }
    ]
  }
]

Changes