VAvapiai
Simulation Runs
Simulation Run Items

List Simulation Run Items

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

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

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

OR

Example response

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

Changes

  • 3763037c9b67Revision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.