Create mission

Create a new mission definition

POST /ai/missions

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const mission = await client.ai.missions.create({ name: 'name' });

console.log(mission.data);

201

{
  "data": {
    "mission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "execution_mode": "external",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "model": "<string>",
    "instructions": "<string>",
    "metadata": {}
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

description · string

model · string

instructions · string

execution_mode · enum<string> · default: external

Available options: external, managed

metadata · Metadata · object

Response

201

application/json

Successful Response

data · MissionData · object · required

Show child attributes