Create initial plan

Create the initial plan for a run

POST /ai/missions/{mission_id}/runs/{run_id}/plan

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 plan = await client.ai.missions.runs.plan.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  steps: [
    {
      description: 'description',
      sequence: 0,
      step_id: 'step_id',
    },
  ],
});

console.log(plan.data);

201

{
  "data": [
    {
      "step_id": "<string>",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence": 123,
      "description": "<string>",
      "status": "pending",
      "parent_step_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "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

steps · CreatePlanStepRequest · object[] · required

Show child attributes

Response

201

application/json

Successful Response

data · PlanStepData · object[] · required

Show child attributes