Get an ELP test

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

{
  "id": "elp_3f9a1c2e-7b4d-4f8a-9d3e-2a1b5c6d7e8f",
  "status": "REQUESTED",
  "created_at": "2024-01-15T09:30:00Z",
  "call_id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
  "carrier_id": "car_9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "phone_number": "+1-555-123-4567",
  "driver_name": "Carlos Mendoza",
  "carrier_name": "Swift Logistics Inc.",
  "mc_number": "MC123456",
  "scoring_status": "PENDING",
  "conversational_communication": 7,
  "instruction_comprehension": 8,
  "sign_recognition": 6,
  "verbal_reporting": 7,
  "total_score": 28,
  "total_questions": 30,
  "questions_answered": 29,
  "valid_answers": 27,
  "notes": "Test scheduled, awaiting call completion.",
  "call": {
    "id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
    "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": "+1-555-123-4567",
    "to_number": "+1-555-987-6543",
    "from_number": "+1-555-123-4567",
    "call_start_time": "2024-01-15T09:30:05Z",
    "call_end_time": "2024-01-15T09:45:00Z",
    "transcript": [
      {
        "role": "interviewer",
        "content": "Hello Carlos, can you confirm your current location?",
        "id": "msg_001",
        "timestamp": "2024-01-15T09:30:10Z",
        "interrupted": false,
        "transcript_confidence": 0.98,
        "tool_calls": [
          {
            "id": "tool_123",
            "type": "translation",
            "function": {
              "name": "translateText",
              "arguments": {
                "sourceLanguage": "en",
                "targetLanguage": "es",
                "text": "Hello Carlos, can you confirm your current location?"
              }
            }
          }
        ],
        "tool_call_id": "tool_123"
      },
      {
        "role": "driver",
        "content": "Estoy en la interestatal 40, cerca de Albuquerque.",
        "id": "msg_002",
        "timestamp": "2024-01-15T09:30:20Z",
        "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.

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

{
  "id": "elp_3f9a1c2e-7b4d-4f8a-9d3e-2a1b5c6d7e8f",
  "status": "REQUESTED",
  "created_at": "2024-01-15T09:30:00Z",
  "call_id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
  "carrier_id": "car_9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "phone_number": "+1-555-123-4567",
  "driver_name": "Carlos Mendoza",
  "carrier_name": "Swift Logistics Inc.",
  "mc_number": "MC123456",
  "scoring_status": "PENDING",
  "conversational_communication": 7,
  "instruction_comprehension": 8,
  "sign_recognition": 6,
  "verbal_reporting": 7,
  "total_score": 28,
  "total_questions": 30,
  "questions_answered": 29,
  "valid_answers": 27,
  "notes": "Test scheduled, awaiting call completion.",
  "call": {
    "id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
    "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": "+1-555-123-4567",
    "to_number": "+1-555-987-6543",
    "from_number": "+1-555-123-4567",
    "call_start_time": "2024-01-15T09:30:05Z",
    "call_end_time": "2024-01-15T09:45:00Z",
    "transcript": [
      {
        "role": "interviewer",
        "content": "Hello Carlos, can you confirm your current location?",
        "id": "msg_001",
        "timestamp": "2024-01-15T09:30:10Z",
        "interrupted": false,
        "transcript_confidence": 0.98,
        "tool_calls": [
          {
            "id": "tool_123",
            "type": "translation",
            "function": {
              "name": "translateText",
              "arguments": {
                "sourceLanguage": "en",
                "targetLanguage": "es",
                "text": "Hello Carlos, can you confirm your current location?"
              }
            }
          }
        ],
        "tool_call_id": "tool_123"
      },
      {
        "role": "driver",
        "content": "Estoy en la interestatal 40, cerca de Albuquerque.",
        "id": "msg_002",
        "timestamp": "2024-01-15T09:30:20Z",
        "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.

Allowed values:

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.

Allowed values:

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

Get an ELP test

Get an ELP test

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

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

1	{
2	"id": "elp_3f9a1c2e-7b4d-4f8a-9d3e-2a1b5c6d7e8f",
3	"status": "REQUESTED",
4	"created_at": "2024-01-15T09:30:00Z",
5	"call_id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
6	"carrier_id": "car_9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
7	"phone_number": "+1-555-123-4567",
8	"driver_name": "Carlos Mendoza",
9	"carrier_name": "Swift Logistics Inc.",
10	"mc_number": "MC123456",
11	"scoring_status": "PENDING",
12	"conversational_communication": 7,
13	"instruction_comprehension": 8,
14	"sign_recognition": 6,
15	"verbal_reporting": 7,
16	"total_score": 28,
17	"total_questions": 30,
18	"questions_answered": 29,
19	"valid_answers": 27,
20	"notes": "Test scheduled, awaiting call completion.",
21	"call": {
22	"id": "call_5d7e9f1a-3c4b-4a2d-8e7f-1b2c3d4e5f6a",
23	"status": "COMPLETED",
24	"call_time": "2024-01-15T09:30:00Z",
25	"created_at": "2024-01-15T09:30:00Z",
26	"updated_at": "2024-01-15T09:50:00Z",
27	"call_direction": "outbound",
28	"phone_number": "+1-555-123-4567",
29	"to_number": "+1-555-987-6543",
30	"from_number": "+1-555-123-4567",
31	"call_start_time": "2024-01-15T09:30:05Z",
32	"call_end_time": "2024-01-15T09:45:00Z",
33	"transcript": [
34	{
35	"role": "interviewer",
36	"content": "Hello Carlos, can you confirm your current location?",
37	"id": "msg_001",
38	"timestamp": "2024-01-15T09:30:10Z",
39	"interrupted": false,
40	"transcript_confidence": 0.98,
41	"tool_calls": [
42	{
43	"id": "tool_123",
44	"type": "translation",
45	"function": {
46	"name": "translateText",
47	"arguments": {
48	"sourceLanguage": "en",
49	"targetLanguage": "es",
50	"text": "Hello Carlos, can you confirm your current location?"
51	}
52	}
53	}
54	],
55	"tool_call_id": "tool_123"
56	},
57	{
58	"role": "driver",
59	"content": "Estoy en la interestatal 40, cerca de Albuquerque.",
60	"id": "msg_002",
61	"timestamp": "2024-01-15T09:30:20Z",
62	"interrupted": false,
63	"transcript_confidence": 0.95,
64	"tool_calls": null,
65	"tool_call_id": null
66	}
67	]
68	}
69	}