Telnyx Missions API
The Missions API from Telnyx — 23 operation(s) for missions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx-missions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: support@telnyx.com
description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
title: Telnyx Missions API
version: 2.0.0
x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- name: Missions
paths:
/ai/missions:
get:
description: List all missions for the organization
operationId: get_public_missions_missions
parameters:
- description: Page number (1-based)
in: query
name: page[number]
required: false
schema:
default: 1
description: Page number (1-based)
minimum: 1
title: Page[Number]
type: integer
- description: Number of items per page
in: query
name: page[size]
required: false
schema:
default: 20
description: Number of items per page
exclusiveMinimum: 0
maximum: 1000
minimum: 0
title: Page[Size]
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionsListResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List missions
tags:
- Missions
x-latency-category: responsive
post:
description: Create a new mission definition
operationId: post_public_missions_missions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMissionRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create mission
tags:
- Missions
x-latency-category: responsive
/ai/missions/events:
get:
description: List recent events across all missions
operationId: get_public_missions_missions_events
parameters:
- in: query
name: type
required: false
schema:
title: Type
type: string
- description: Page number (1-based)
in: query
name: page[number]
required: false
schema:
default: 1
description: Page number (1-based)
minimum: 1
title: Page[Number]
type: integer
- description: Number of items per page
in: query
name: page[size]
required: false
schema:
default: 50
description: Number of items per page
exclusiveMinimum: 0
maximum: 1000
minimum: 0
title: Page[Size]
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventsListResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List recent events
tags:
- Missions
x-latency-category: responsive
/ai/missions/runs:
get:
description: List recent runs across all missions
operationId: get_public_missions_missions_runs
parameters:
- in: query
name: status
required: false
schema:
title: Status
type: string
- description: Page number (1-based)
in: query
name: page[number]
required: false
schema:
default: 1
description: Page number (1-based)
minimum: 1
title: Page[Number]
type: integer
- description: Number of items per page
in: query
name: page[size]
required: false
schema:
default: 20
description: Number of items per page
exclusiveMinimum: 0
maximum: 1000
minimum: 0
title: Page[Size]
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunsListResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List recent runs
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}:
delete:
description: Delete a mission
operationId: delete_public_missions_missions_mission_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
responses:
'204':
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Delete mission
tags:
- Missions
x-latency-category: responsive
get:
description: Get a mission by ID (includes tools, knowledge_bases, mcp_servers)
operationId: get_public_missions_missions_mission_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get mission
tags:
- Missions
x-latency-category: responsive
put:
description: Update a mission definition
operationId: put_public_missions_missions_mission_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMissionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Update mission
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/clone:
post:
description: Clone an existing mission
operationId: post_public_missions_missions_mission_id_clone
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
responses:
'201':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Clone mission
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/knowledge-bases:
get:
description: List all knowledge bases for a mission
operationId: get_public_missions_missions_mission_id_knowledge_bases
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List knowledge bases
tags:
- Missions
x-latency-category: responsive
post:
description: Create a new knowledge base for a mission
operationId: post_public_missions_missions_mission_id_knowledge_bases
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
responses:
'201':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create knowledge base
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}:
delete:
description: Delete a knowledge base from a mission
operationId: delete_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: knowledge_base_id
required: true
schema:
title: Knowledge Base Id
type: string
responses:
'204':
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Delete knowledge base
tags:
- Missions
x-latency-category: responsive
get:
description: Get a specific knowledge base by ID
operationId: get_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: knowledge_base_id
required: true
schema:
title: Knowledge Base Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get knowledge base
tags:
- Missions
x-latency-category: responsive
put:
description: Update a knowledge base definition
operationId: put_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: knowledge_base_id
required: true
schema:
title: Knowledge Base Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Update knowledge base
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/mcp-servers:
get:
description: List all MCP servers for a mission
operationId: get_public_missions_missions_mission_id_mcp_servers
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List MCP servers
tags:
- Missions
x-latency-category: responsive
post:
description: Create a new MCP server for a mission
operationId: post_public_missions_missions_mission_id_mcp_servers
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
responses:
'201':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create MCP server
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}:
delete:
description: Delete an MCP server from a mission
operationId: delete_public_missions_missions_mission_id_mcp_servers_mcp_server_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: mcp_server_id
required: true
schema:
title: Mcp Server Id
type: string
responses:
'204':
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Delete MCP server
tags:
- Missions
x-latency-category: responsive
get:
description: Get a specific MCP server by ID
operationId: get_public_missions_missions_mission_id_mcp_servers_mcp_server_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: mcp_server_id
required: true
schema:
title: Mcp Server Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get MCP server
tags:
- Missions
x-latency-category: responsive
put:
description: Update an MCP server definition
operationId: put_public_missions_missions_mission_id_mcp_servers_mcp_server_id
parameters:
- in: path
name: mission_id
required: true
schema:
title: Mission Id
type: string
- in: path
name: mcp_server_id
required: true
schema:
title: Mcp Server Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Update MCP server
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs:
get:
description: List all runs for a specific mission
operationId: get_public_missions_missions_mission_id_runs
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: query
name: status
required: false
schema:
title: Status
type: string
- description: Page number (1-based)
in: query
name: page[number]
required: false
schema:
default: 1
description: Page number (1-based)
minimum: 1
title: Page[Number]
type: integer
- description: Number of items per page
in: query
name: page[size]
required: false
schema:
default: 20
description: Number of items per page
exclusiveMinimum: 0
maximum: 1000
minimum: 0
title: Page[Size]
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunsListResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List runs for mission
tags:
- Missions
x-latency-category: responsive
post:
description: Start a new run for a mission
operationId: post_public_missions_missions_mission_id_runs
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMissionRunRequest'
default: {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Start a run
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}:
get:
description: Get details of a specific run
operationId: get_public_missions_missions_mission_id_runs_run_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get run details
tags:
- Missions
x-latency-category: responsive
patch:
description: Update run status and/or result
operationId: patch_public_missions_missions_mission_id_runs_run_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMissionRunRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Update run
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/cancel:
post:
description: Cancel a running or paused run
operationId: post_public_missions_missions_mission_id_runs_run_id_cancel
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Cancel run
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/events:
get:
description: List events for a run (paginated)
operationId: get_public_missions_missions_mission_id_runs_run_id_events
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
- in: query
name: type
required: false
schema:
title: Type
type: string
- in: query
name: step_id
required: false
schema:
title: Step Id
type: string
- in: query
name: agent_id
required: false
schema:
title: Agent Id
type: string
- description: Page number (1-based)
in: query
name: page[number]
required: false
schema:
default: 1
description: Page number (1-based)
minimum: 1
title: Page[Number]
type: integer
- description: Number of items per page
in: query
name: page[size]
required: false
schema:
default: 50
description: Number of items per page
exclusiveMinimum: 0
maximum: 1000
minimum: 0
title: Page[Size]
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventsListResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List events
tags:
- Missions
x-latency-category: responsive
post:
description: Log an event for a run
operationId: post_public_missions_missions_mission_id_runs_run_id_events
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEventRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/EventResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Log event
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/events/{event_id}:
get:
description: Get details of a specific event
operationId: get_public_missions_missions_mission_id_runs_run_id_events_event_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
- in: path
name: event_id
required: true
schema:
title: Event Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EventResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get event details
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/pause:
post:
description: Pause a running run
operationId: post_public_missions_missions_mission_id_runs_run_id_pause
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MissionRunResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Pause run
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/plan:
get:
description: Get the plan (all steps) for a run
operationId: get_public_missions_missions_mission_id_runs_run_id_plan
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PlanResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get plan
tags:
- Missions
x-latency-category: responsive
post:
description: Create the initial plan for a run
operationId: post_public_missions_missions_mission_id_runs_run_id_plan
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PlanStepsCreatedResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create initial plan
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/plan/steps:
post:
description: Add one or more steps to an existing plan
operationId: post_public_missions_missions_mission_id_runs_run_id_plan_steps
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddPlanStepsRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PlanStepsCreatedResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Add step(s) to plan
tags:
- Missions
x-latency-category: responsive
/ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}:
get:
description: Get details of a specific plan step
operationId: get_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
required: true
schema:
format: uuid
title: Run Id
type: string
- in: path
name: step_id
required: true
schema:
title: Step Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PlanStepResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get step details
tags:
- Missions
x-latency-category: responsive
patch:
description: Update the status of a plan step
operationId: patch_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id
parameters:
- in: path
name: mission_id
required: true
schema:
format: uuid
title: Mission Id
type: string
- in: path
name: run_id
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-missions-api-openapi.yml