Skip to main content
PATCH
/
ai
/
missions
/
{mission_id}
/
runs
/
{run_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const run = await client.ai.missions.runs.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(run.data);
{
  "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": {}
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

mission_id
string<uuid>
required
run_id
string<uuid>
required

Body

application/json
status
enum<string>
Available options:
pending,
running,
paused,
succeeded,
failed,
cancelled
result_summary
string
result_payload
Result Payload · object
error
string
metadata
Metadata · object

Response

Successful Response

data
MissionRunData · object
required