GET
/
test_framework
/
v1
/
runs-external
/
bulk
curl --request GET \
  --url https://new-prod.vocera.ai/test_framework/v1/runs-external/bulk/ \
  --header 'X-VOCERA-API-KEY: <api-key>'
[
  {
    "id": 123,
    "scenario": 123,
    "scenario_name": "<string>",
    "expected_outcome_prompt": "<string>",
    "expected_outcome": "<any>",
    "success": true,
    "evaluation": "<any>",
    "transcript": "<string>",
    "transcript_object": "<any>",
    "duration": "<string>",
    "voice_recording_url": "<string>",
    "email_id": "jsmith@example.com",
    "status": "running",
    "metadata": "<any>",
    "feedback": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "outbound_number": "<string>",
    "critical_categories": "<string>"
  }
]

Authorizations

​
X-VOCERA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Query Parameters

​
run_ids
string
required

Comma-separated list of run IDs

Response

200 - application/json
​
id
integer
required
​
scenario
integer | null
required
​
scenario_name
string
required

Name of the scenario this run belongs to

​
expected_outcome_prompt
string
required

Prompt describing the expected outcome for this scenario run

​
expected_outcome
any
required
​
success
boolean
required
​
evaluation
any | null
required
​
transcript
string
required
​
transcript_object
any | null
required
​
duration
string
required

Duration of the run in MM:SS format

​
voice_recording_url
string
required

URL to access the voice recording of this run

​
email_id
string | null
required
​
status
enum<string>
required
  • running - Running
  • completed - Completed
  • failed - Failed
  • pending - Pending
  • in_progress - In Progress
  • evaluating - Evaluating
  • in_queue - In Queue
  • timeout - Timeout
Available options:
running,
completed,
failed,
pending,
in_progress,
evaluating,
in_queue,
timeout
​
metadata
any | null
required
​
timestamp
string
required
​
outbound_number
string
required

Phone number used to make the outbound call for this run

​
critical_categories
string
required

List of critical evaluation categories and their results for this run

​
feedback
string