Get an ELP test

{
  "id": "elp_3f9a1b2c-4d5e-6789-abcd-1234567890ef",
  "status": "REQUESTED",
  "created_at": "2024-01-15T09:30:00Z",
  "call_id": "call_7a8b9c0d-1e2f-3456-789a-bcdef0123456",
  "carrier_id": "car_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  "phone_number": "+15551234567",
  "driver_name": "John Doe",
  "carrier_name": "Acme Freight Logistics",
  "mc_number": "MC123456",
  "scoring_status": "PENDING",
  "conversational_communication": 4,
  "instruction_comprehension": 5,
  "sign_recognition": 3,
  "verbal_reporting": 4,
  "total_score": 16,
  "total_questions": 20,
  "questions_answered": 18,
  "valid_answers": 17,
  "notes": "Test scheduled, awaiting call completion.",
  "call": {
    "id": "call_7a8b9c0d-1e2f-3456-789a-bcdef0123456",
    "status": "COMPLETED",
    "call_time": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:50:00Z",
    "call_direction": "outbound",
    "phone_number": "+15551234567",
    "to_number": "+15557654321",
    "from_number": "+15551234567",
    "call_start_time": "2024-01-15T09:30:05Z",
    "call_end_time": "2024-01-15T09:45:00Z",
    "transcript": [
      {
        "role": "interviewer",
        "content": "Hello, this is Envoy AI. Can you please confirm your name?",
        "id": "msg_001",
        "timestamp": "2024-01-15T09:30:10Z",
        "interrupted": false,
        "transcript_confidence": 0.98,
        "tool_calls": [
          {
            "id": "tool_123",
            "type": "intent_detection",
            "function": {
              "name": "detect_intent",
              "arguments": {
                "text": "Hello, this is Envoy AI. Can you please confirm your name?"
              }
            }
          }
        ],
        "tool_call_id": "tool_123"
      },
      {
        "role": "candidate",
        "content": "My name is John Doe.",
        "id": "msg_002",
        "timestamp": "2024-01-15T09:30:15Z",
        "interrupted": false,
        "transcript_confidence": 0.95,
        "tool_calls": null,
        "tool_call_id": null
      }
    ]
  }
}

Get a specific ELP test by ID, including the associated call and transcript.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

test_idstringRequiredformat: "uuid"

Response

Successful Response

idstringformat: "^elp_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

statusenum

Lifecycle state of an ELP test.

Tracks whether the test ran, not its outcome quality. Outcome quality lives in the per-competency scores and the question counters (questions_answered, valid_answers). The system never renders a pass/fail verdict.

created_atdatetime

call_idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

carrier_idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

phone_numberstring or null

driver_namestring or null

carrier_namestring or null

mc_numberstring or null

scoring_statusenum or null

Status of the post-call scoring pipeline.

conversational_communicationinteger or null

instruction_comprehensioninteger or null

sign_recognitioninteger or null

verbal_reportinginteger or null

total_scoreinteger or null

total_questionsinteger or null

questions_answeredinteger or null

valid_answersinteger or null

notesstring or null

callobject or null

Associated phone call with transcript

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl https://tryenvoy.ai/api/v1/elp/tests/test_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

Authentication

Path parameters

Headers

Response

Errors