Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check out our upcoming events and meetups! View events →
List events for a run (paginated)
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const eventData of client.ai.missions.runs.events.list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
)) {
console.log(eventData.event_id);
}{
"data": [
{
"event_id": "<string>",
"run_id": "<string>",
"summary": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"step_id": "<string>",
"agent_id": "<string>",
"payload": {},
"idempotency_key": "<string>"
}
],
"meta": {
"total_pages": 123,
"total_results": 123,
"page_number": 123,
"page_size": 123
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Unique identifier of the mission.
Unique identifier of the run.
Filter results by type.
Filter results by step id.
Filter results by agent id.
Page number (1-based)
x >= 1Number of items per page
x <= 1000Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const eventData of client.ai.missions.runs.events.list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
)) {
console.log(eventData.event_id);
}{
"data": [
{
"event_id": "<string>",
"run_id": "<string>",
"summary": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"step_id": "<string>",
"agent_id": "<string>",
"payload": {},
"idempotency_key": "<string>"
}
],
"meta": {
"total_pages": 123,
"total_results": 123,
"page_number": 123,
"page_size": 123
}
}