Install any skill in seconds. Free to start, no credit card required.
Get Started Free →Create and manage Telnyx Missions — automated workflows, tasks, and sub-resources for AI-driven telecom operations. This skill provides Ruby SDK examples.
.claude/skills/team-telnyx-telnyx-missions-ruby/SKILL.md| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-01 | ✗→✓ | ▲ Improved | 332% | 0% |
| case-02 | ✗→✓ | ▲ Improved | 336% | 0% |
| case-03 | ✗→✓ | ▲ Improved | 377% | 0% |
| case-05 | ✗→✓ | ▲ Improved | 498% | 0% |
| case-06 | ✗→✓ | ▲ Improved | 310% | 0% |
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
bashgem install telnyx
rubyrequire "telnyx" client = Telnyx::Client.new( api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted )
All examples below assume client is already initialized as shown above.
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
rubybegin result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello") rescue Telnyx::Errors::APIConnectionError puts "Network error — check connectivity and retry" rescue Telnyx::Errors::RateLimitError # 429: rate limited — wait and retry with exponential backoff sleep(1) # Check Retry-After header for actual delay rescue Telnyx::Errors::APIStatusError => e puts "API error #{e.status}: #{e.message}" if e.status == 422 puts "Validation error — check required fields and formats" end end
Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).
.auto_paging_each for automatic iteration: page.auto_paging_each { |item| puts item.id }.List all missions for the organization
GET /ai/missions
rubypage = client.ai.missions.list puts(page)
Returns: created_at (date-time), description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), mission_id (uuid), model (string), name (string), updated_at (date-time)
Create a new mission definition
POST /ai/missions — Required: name
Optional: description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), model (string)
rubymission = client.ai.missions.create(name: "my-resource") puts(mission)
Returns: created_at (date-time), description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), mission_id (uuid), model (string), name (string), updated_at (date-time)
List recent events across all missions
GET /ai/missions/events
rubypage = client.ai.missions.list_events puts(page)
Returns: agent_id (string), event_id (string), idempotency_key (string), payload (object), run_id (string), step_id (string), summary (string), timestamp (date-time), type (enum: status_change, step_started, step_completed, step_failed, tool_call, tool_result, message, error, custom)
List recent runs across all missions
GET /ai/missions/runs
rubypage = client.ai.missions.runs.list_runs puts(page)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Get a mission by ID (includes tools, knowledge_bases, mcp_servers)
GET /ai/missions/{mission_id}
rubymission = client.ai.missions.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") puts(mission)
Returns: created_at (date-time), description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), mission_id (uuid), model (string), name (string), updated_at (date-time)
Update a mission definition
PUT /ai/missions/{mission_id}
Optional: description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), model (string), name (string)
rubyresponse = client.ai.missions.update_mission("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") puts(response)
Returns: created_at (date-time), description (string), execution_mode (enum: external, managed), instructions (string), metadata (object), mission_id (uuid), model (string), name (string), updated_at (date-time)
Delete a mission
DELETE /ai/missions/{mission_id}
rubyresult = client.ai.missions.delete_mission("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") puts(result)
Clone an existing mission
POST /ai/missions/{mission_id}/clone
rubyresponse = client.ai.missions.clone_mission("mission_id") puts(response)
List all knowledge bases for a mission
GET /ai/missions/{mission_id}/knowledge-bases
rubyresponse = client.ai.missions.knowledge_bases.list_knowledge_bases("mission_id") puts(response)
Create a new knowledge base for a mission
POST /ai/missions/{mission_id}/knowledge-bases
rubyresponse = client.ai.missions.knowledge_bases.create_knowledge_base("mission_id") puts(response)
Get a specific knowledge base by ID
GET /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
rubyresponse = client.ai.missions.knowledge_bases.get_knowledge_base("knowledge_base_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Update a knowledge base definition
PUT /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
rubyresponse = client.ai.missions.knowledge_bases.update_knowledge_base("knowledge_base_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Delete a knowledge base from a mission
DELETE /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}
rubyresult = client.ai.missions.knowledge_bases.delete_knowledge_base("knowledge_base_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(result)
List all MCP servers for a mission
GET /ai/missions/{mission_id}/mcp-servers
rubyresponse = client.ai.missions.mcp_servers.list_mcp_servers("mission_id") puts(response)
Create a new MCP server for a mission
POST /ai/missions/{mission_id}/mcp-servers
rubyresponse = client.ai.missions.mcp_servers.create_mcp_server("mission_id") puts(response)
Get a specific MCP server by ID
GET /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
rubyresponse = client.ai.missions.mcp_servers.get_mcp_server("mcp_server_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Update an MCP server definition
PUT /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
rubyresponse = client.ai.missions.mcp_servers.update_mcp_server("mcp_server_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Delete an MCP server from a mission
DELETE /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}
rubyresult = client.ai.missions.mcp_servers.delete_mcp_server("mcp_server_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(result)
List all runs for a specific mission
GET /ai/missions/{mission_id}/runs
rubypage = client.ai.missions.runs.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") puts(page)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Start a new run for a mission
POST /ai/missions/{mission_id}/runs
Optional: input (object), metadata (object)
rubyrun = client.ai.missions.runs.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") puts(run)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Get details of a specific run
GET /ai/missions/{mission_id}/runs/{run_id}
rubyrun = client.ai.missions.runs.retrieve( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(run)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Update run status and/or result
PATCH /ai/missions/{mission_id}/runs/{run_id}
Optional: error (string), metadata (object), result_payload (object), result_summary (string), status (enum: pending, running, paused, succeeded, failed, cancelled)
rubyrun = client.ai.missions.runs.update( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(run)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Cancel a running or paused run
POST /ai/missions/{mission_id}/runs/{run_id}/cancel
rubyresponse = client.ai.missions.runs.cancel_run( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
List events for a run (paginated)
GET /ai/missions/{mission_id}/runs/{run_id}/events
rubypage = client.ai.missions.runs.events.list( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(page)
Returns: agent_id (string), event_id (string), idempotency_key (string), payload (object), run_id (string), step_id (string), summary (string), timestamp (date-time), type (enum: status_change, step_started, step_completed, step_failed, tool_call, tool_result, message, error, custom)
Log an event for a run
POST /ai/missions/{mission_id}/runs/{run_id}/events — Required: type, summary
Optional: agent_id (string), idempotency_key (string), payload (object), step_id (string)
rubyresponse = client.ai.missions.runs.events.log( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", summary: "Brief task summary", type: :status_change ) puts(response)
Returns: agent_id (string), event_id (string), idempotency_key (string), payload (object), run_id (string), step_id (string), summary (string), timestamp (date-time), type (enum: status_change, step_started, step_completed, step_failed, tool_call, tool_result, message, error, custom)
Get details of a specific event
GET /ai/missions/{mission_id}/runs/{run_id}/events/{event_id}
rubyresponse = client.ai.missions.runs.events.get_event_details( "event_id", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", run_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: agent_id (string), event_id (string), idempotency_key (string), payload (object), run_id (string), step_id (string), summary (string), timestamp (date-time), type (enum: status_change, step_started, step_completed, step_failed, tool_call, tool_result, message, error, custom)
Pause a running run
POST /ai/missions/{mission_id}/runs/{run_id}/pause
rubyresponse = client.ai.missions.runs.pause_run( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
Get the plan (all steps) for a run
GET /ai/missions/{mission_id}/runs/{run_id}/plan
rubyplan = client.ai.missions.runs.plan.retrieve( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(plan)
Returns: completed_at (date-time), description (string), metadata (object), parent_step_id (string), run_id (uuid), sequence (integer), started_at (date-time), status (enum: pending, in_progress, completed, skipped, failed), step_id (string)
Create the initial plan for a run
POST /ai/missions/{mission_id}/runs/{run_id}/plan — Required: steps
rubyplan = 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: "550e8400-e29b-41d4-a716-446655440000"}] ) puts(plan)
Returns: completed_at (date-time), description (string), metadata (object), parent_step_id (string), run_id (uuid), sequence (integer), started_at (date-time), status (enum: pending, in_progress, completed, skipped, failed), step_id (string)
Add one or more steps to an existing plan
POST /ai/missions/{mission_id}/runs/{run_id}/plan/steps — Required: steps
rubyresponse = client.ai.missions.runs.plan.add_steps_to_plan( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", steps: [{description: "description", sequence: 0, step_id: "550e8400-e29b-41d4-a716-446655440000"}] ) puts(response)
Returns: completed_at (date-time), description (string), metadata (object), parent_step_id (string), run_id (uuid), sequence (integer), started_at (date-time), status (enum: pending, in_progress, completed, skipped, failed), step_id (string)
Get details of a specific plan step
GET /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}
rubyresponse = client.ai.missions.runs.plan.get_step_details( "step_id", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", run_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: completed_at (date-time), description (string), metadata (object), parent_step_id (string), run_id (uuid), sequence (integer), started_at (date-time), status (enum: pending, in_progress, completed, skipped, failed), step_id (string)
Update the status of a plan step
PATCH /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}
Optional: metadata (object), status (enum: pending, in_progress, completed, skipped, failed)
rubyresponse = client.ai.missions.runs.plan.update_step( "step_id", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", run_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: completed_at (date-time), description (string), metadata (object), parent_step_id (string), run_id (uuid), sequence (integer), started_at (date-time), status (enum: pending, in_progress, completed, skipped, failed), step_id (string)
Resume a paused run
POST /ai/missions/{mission_id}/runs/{run_id}/resume
rubyresponse = client.ai.missions.runs.resume_run( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(response)
Returns: error (string), finished_at (date-time), input (object), metadata (object), mission_id (uuid), result_payload (object), result_summary (string), run_id (uuid), started_at (date-time), status (enum: pending, running, paused, succeeded, failed, cancelled), updated_at (date-time)
List all Telnyx agents linked to a run
GET /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents
rubytelnyx_agents = client.ai.missions.runs.telnyx_agents.list( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(telnyx_agents)
Returns: created_at (date-time), run_id (string), telnyx_agent_id (string)
Link a Telnyx AI agent (voice/messaging) to a run
POST /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents — Required: telnyx_agent_id
rubyresponse = client.ai.missions.runs.telnyx_agents.link( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", telnyx_agent_id: "550e8400-e29b-41d4-a716-446655440000" ) puts(response)
Returns: created_at (date-time), run_id (string), telnyx_agent_id (string)
Unlink a Telnyx agent from a run
DELETE /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}
rubyresult = client.ai.missions.runs.telnyx_agents.unlink( "telnyx_agent_id", mission_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", run_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ) puts(result)
List all tools for a mission
GET /ai/missions/{mission_id}/tools
rubyresponse = client.ai.missions.tools.list_tools("mission_id") puts(response)
Create a new tool for a mission
POST /ai/missions/{mission_id}/tools
rubyresponse = client.ai.missions.tools.create_tool("mission_id") puts(response)
Get a specific tool by ID
GET /ai/missions/{mission_id}/tools/{tool_id}
rubyresponse = client.ai.missions.tools.get_tool("tool_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Update a tool definition
PUT /ai/missions/{mission_id}/tools/{tool_id}
rubyresponse = client.ai.missions.tools.update_tool("tool_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(response)
Delete a tool from a mission
DELETE /ai/missions/{mission_id}/tools/{tool_id}
rubyresult = client.ai.missions.tools.delete_tool("tool_id", mission_id: "550e8400-e29b-41d4-a716-446655440000") puts(result)
| Case | Status | Duration (ms) | Turns | Tokens | Tool calls | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Without | With | Δ | Without | With | Δ | Without | With | Δ | Without | With | Δ | ||
case-01 | fail→pass | 10,994 | 8,062 | -27% | 1 | 1 | 0% | 2,049 | 8,851 | +332% | 0 | 0 | — |
case-02 | fail→pass | 9,531 | 5,341 | -44% | 1 | 1 | 0% | 1,873 | 8,167 | +336% | 0 | 0 | — |
case-03 | fail→pass | 9,219 | 7,055 | -23% | 1 | 1 | 0% | 1,822 | 8,695 | +377% | 0 | 0 | — |
case-04 | pass→pass | 9,728 | 3,273 | -66% | 1 | 1 | 0% | 1,756 | 7,679 | +337% | 0 | 0 | — |
case-05 | fail→pass | 6,683 | 6,512 | -3% | 1 | 1 | 0% | 1,432 | 8,560 | +498% | 0 | 0 | — |
case-06 | fail→pass | 10,507 | 5,019 | -52% | 1 | 1 | 0% | 1,987 | 8,149 | +310% | 0 | 0 | — |
case-07 | fail→pass | 12,236 | 4,332 | -65% | 1 | 1 | 0% | 1,985 | 7,913 | +299% | 0 | 0 | — |
case-08 | fail→pass | 13,846 | 3,884 | -72% | 1 | 1 | 0% | 2,508 | 7,848 | +213% | 0 | 0 | — |
case-09 | fail→pass | 7,831 | 3,437 | -56% | 1 | 1 | 0% | 1,385 | 7,791 | +463% | 0 | 0 | — |
case-10 | fail→pass | 7,110 | 4,905 | -31% | 1 | 1 | 0% | 1,305 | 8,100 | +521% | 0 | 0 | — |
case-11 | fail→pass | 13,174 | 3,606 | -73% | 1 | 1 | 0% | 2,563 | 7,799 | +204% | 0 | 0 | — |
case-12 | fail→pass | 10,615 | 3,642 | -66% | 1 | 1 | 0% | 2,127 | 7,877 | +270% | 0 | 0 | — |
case-13 | fail→pass | 7,822 | 2,934 | -62% | 1 | 1 | 0% | 1,411 | 7,619 | +440% | 0 | 0 | — |
case-14 | fail→pass | 9,880 | 3,473 | -65% | 1 | 1 | 0% | 2,065 | 7,829 | +279% | 0 | 0 | — |
case-15 | fail→pass | 10,508 | 3,763 | -64% | 1 | 1 | 0% | 2,124 | 7,922 | +273% | 0 | 0 | — |
case-16 | fail→pass | 10,632 | 5,437 | -49% | 1 | 1 | 0% | 2,083 | 8,308 | +299% | 0 | 0 | — |
case-17 | fail→pass | 13,677 | 5,252 | -62% | 1 | 1 | 0% | 2,593 | 8,191 | +216% | 0 | 0 | — |
case-18 | fail→pass | 11,275 | 5,631 | -50% | 1 | 1 | 0% | 2,286 | 8,437 | +269% | 0 | 0 | — |
case-19 | fail→pass | 10,116 | 4,025 | -60% | 1 | 1 | 0% | 1,898 | 7,852 | +314% | 0 | 0 | — |
case-20 | pass→pass | 5,985 | 4,401 | -26% | 1 | 1 | 0% | 1,213 | 7,943 | +555% | 0 | 0 | — |
case-21 | pass→pass | 8,534 | 3,803 | -55% | 1 | 1 | 0% | 1,639 | 7,849 | +379% | 0 | 0 | — |
case-22 | pass→pass | 4,076 | 3,657 | -10% | 1 | 1 | 0% | 848 | 7,912 | +833% | 0 | 0 | — |
case-23 | pass→pass | 10,578 | 9,277 | -12% | 1 | 1 | 0% | 1,855 | 8,751 | +372% | 0 | 0 | — |
case-24 | pass→pass | 12,320 | 6,941 | -44% | 1 | 1 | 0% | 2,501 | 8,391 | +236% | 0 | 0 | — |
DecimalAI ran this skill against gemini-3.6-flash twice over the same eval suite — once with the skill loaded and once without — and compared the two runs case by case. 24 cases were attempted. The headline lift of +75 percentage points is the difference between those two pass rates over the 24 comparable cases.
Without the skill loaded, the model failed this case. With it loaded, the same prompt on the same model passed. This is one improved case from the latest verified run; every case, including any that regressed, is in the table above.
Other measured skills in the registry, with their headline benchmark lift.