Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx Missions API

The Missions API from Telnyx — 23 operation(s) for missions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx Missions API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Missions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 41 operations across 23 paths, and defines 33 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

41 operations 23 paths 33 schemas 5 DELETE17 GET2 PATCH13 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx Missions API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 41

Across 23 paths, the API surfaces 41 operations — 5 DELETE, 17 GET, 2 PATCH, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Missions 41
GET
/ai/missions
List missions
get_public_missions_missions 2 params → 200422
POST
/ai/missions
Create mission
post_public_missions_missions body → 201422
GET
/ai/missions/events
List recent events
get_public_missions_missions_events 3 params → 200422
GET
/ai/missions/runs
List recent runs
get_public_missions_missions_runs 3 params → 200422
DELETE
/ai/missions/{mission_id}
Delete mission
delete_public_missions_missions_mission_id 1 param → 204422
GET
/ai/missions/{mission_id}
Get mission
get_public_missions_missions_mission_id 1 param → 200422
PUT
/ai/missions/{mission_id}
Update mission
put_public_missions_missions_mission_id 1 param body → 200422
POST
/ai/missions/{mission_id}/clone
Clone mission
post_public_missions_missions_mission_id_clone 1 param → 201422
GET
/ai/missions/{mission_id}/knowledge-bases
List knowledge bases
get_public_missions_missions_mission_id_knowledge_bases 1 param → 200422
POST
/ai/missions/{mission_id}/knowledge-bases
Create knowledge base
post_public_missions_missions_mission_id_knowledge_bases 1 param → 201422
DELETE
/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
Delete knowledge base
delete_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id 2 params → 204422
GET
/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
Get knowledge base
get_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id 2 params → 200422
PUT
/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
Update knowledge base
put_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id 2 params → 200422
GET
/ai/missions/{mission_id}/mcp-servers
List MCP servers
get_public_missions_missions_mission_id_mcp_servers 1 param → 200422
POST
/ai/missions/{mission_id}/mcp-servers
Create MCP server
post_public_missions_missions_mission_id_mcp_servers 1 param → 201422
DELETE
/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
Delete MCP server
delete_public_missions_missions_mission_id_mcp_servers_mcp_server_id 2 params → 204422
GET
/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
Get MCP server
get_public_missions_missions_mission_id_mcp_servers_mcp_server_id 2 params → 200422
PUT
/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
Update MCP server
put_public_missions_missions_mission_id_mcp_servers_mcp_server_id 2 params → 200422
GET
/ai/missions/{mission_id}/runs
List runs for mission
get_public_missions_missions_mission_id_runs 4 params → 200422
POST
/ai/missions/{mission_id}/runs
Start a run
post_public_missions_missions_mission_id_runs 1 param body → 201422
GET
/ai/missions/{mission_id}/runs/{run_id}
Get run details
get_public_missions_missions_mission_id_runs_run_id 2 params → 200422
PATCH
/ai/missions/{mission_id}/runs/{run_id}
Update run
patch_public_missions_missions_mission_id_runs_run_id 2 params body → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/cancel
Cancel run
post_public_missions_missions_mission_id_runs_run_id_cancel 2 params → 200422
GET
/ai/missions/{mission_id}/runs/{run_id}/events
List events
get_public_missions_missions_mission_id_runs_run_id_events 7 params → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/events
Log event
post_public_missions_missions_mission_id_runs_run_id_events 2 params body → 201422
GET
/ai/missions/{mission_id}/runs/{run_id}/events/{event_id}
Get event details
get_public_missions_missions_mission_id_runs_run_id_events_event_id 3 params → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/pause
Pause run
post_public_missions_missions_mission_id_runs_run_id_pause 2 params → 200422
GET
/ai/missions/{mission_id}/runs/{run_id}/plan
Get plan
get_public_missions_missions_mission_id_runs_run_id_plan 2 params → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/plan
Create initial plan
post_public_missions_missions_mission_id_runs_run_id_plan 2 params body → 201422
POST
/ai/missions/{mission_id}/runs/{run_id}/plan/steps
Add step(s) to plan
post_public_missions_missions_mission_id_runs_run_id_plan_steps 2 params body → 201422
GET
/ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}
Get step details
get_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id 3 params → 200422
PATCH
/ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}
Update step status
patch_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id 3 params body → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/resume
Resume run
post_public_missions_missions_mission_id_runs_run_id_resume 2 params → 200422
GET
/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents
List linked Telnyx agents
get_public_missions_missions_mission_id_runs_run_id_telnyx_agents 2 params → 200422
POST
/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents
Link Telnyx agent to run
post_public_missions_missions_mission_id_runs_run_id_telnyx_agents 2 params body → 201422
DELETE
/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}
Unlink Telnyx agent
delete_public_missions_missions_mission_id_runs_run_id_telnyx_agents_telnyx_agent_id 3 params → 204422
GET
/ai/missions/{mission_id}/tools
List tools
get_public_missions_missions_mission_id_tools 1 param → 200422
POST
/ai/missions/{mission_id}/tools
Create tool
post_public_missions_missions_mission_id_tools 1 param → 201422
DELETE
/ai/missions/{mission_id}/tools/{tool_id}
Delete tool
delete_public_missions_missions_mission_id_tools_tool_id 2 params → 204422
GET
/ai/missions/{mission_id}/tools/{tool_id}
Get tool
get_public_missions_missions_mission_id_tools_tool_id 2 params → 200422
PUT
/ai/missions/{mission_id}/tools/{tool_id}
Update tool
put_public_missions_missions_mission_id_tools_tool_id 2 params → 200422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are MissionRunData (11 properties), EventData (9 properties), MissionData (9 properties), PlanStepData (9 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
MissionsListResponse
object
2 properties 2 required
MissionData
object
9 properties 5 required
UpdateMissionRunRequest
object
5 properties
Meta
object
4 properties 4 required
EventsListResponse
object
2 properties 2 required
HTTPValidationError
object
1 property
CreatePlanStepRequest
object
5 properties 3 required
UpdatePlanStepRequest
object
2 properties
TelnyxAgentResponse
object
1 property 1 required
MissionRunsListResponse
object
2 properties 2 required
ExecutionMode
string
UpdateMissionRequest
object
6 properties
EventResponse
object
1 property 1 required
MissionRunResponse
object
1 property 1 required
TelnyxAgentData
object
3 properties 3 required
PlanStepsCreatedResponse
object
1 property 1 required
StepStatus
string
RunStatus
string
PlanStepData
object
9 properties 5 required
LinkTelnyxAgentRequest
object
1 property 1 required
PlanStepResponse
object
1 property 1 required
PlanResponse
object
1 property 1 required
CreateMissionRequest
object
6 properties 1 required
EventType
string
EventData
object
9 properties 5 required
MissionResponse
object
1 property 1 required
TelnyxAgentsListResponse
object
1 property 1 required
CreatePlanRequest
object
1 property 1 required
CreateMissionRunRequest
object
2 properties
AddPlanStepsRequest
object
1 property 1 required
MissionRunData
object
11 properties 5 required
CreateEventRequest
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-missions-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#Missions
← Back to T APIs
API Details
ID
telnyx:telnyx-missions-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network