Skip to main content
GET
/
ai
/
missions
/
runs
JavaScript
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 runListRunsResponse of client.ai.missions.runs.listRuns()) {
  console.log(runListRunsResponse.mission_id);
}
{
  "data": [
    {
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "started_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "input": {},
      "finished_at": "2023-11-07T05:31:56Z",
      "result_summary": "<string>",
      "result_payload": {},
      "error": "<string>",
      "metadata": {}
    }
  ],
  "meta": {
    "total_pages": 123,
    "total_results": 123,
    "page_number": 123,
    "page_size": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

status
string
page[number]
integer
default:1

Page number (1-based)

Required range: x >= 1
page[size]
integer
default:20

Number of items per page

Required range: 0 < x <= 1000

Response

Successful Response

data
MissionRunData · object[]
required
meta
Meta · object
required