{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Assistants API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Assistants",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List assistants",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants"
          },
          "docs": "Retrieve a list of all AI Assistants configured by the user."
        },
        {
          "info": {
            "name": "Create an assistant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new AI Assistant."
        },
        {
          "info": {
            "name": "Import assistants from external provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/import",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider."
        },
        {
          "info": {
            "name": "Get All Tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tags"
          },
          "docs": "Get All Tags"
        },
        {
          "info": {
            "name": "List assistant tests with pagination",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests",
            "params": [
              {
                "name": "test_suite",
                "value": "",
                "type": "query",
                "description": "Filter tests by test suite name"
              },
              {
                "name": "telnyx_conversation_channel",
                "value": "",
                "type": "query",
                "description": "Filter tests by communication channel (e.g., 'web_chat', 'sms')"
              },
              {
                "name": "destination",
                "value": "",
                "type": "query",
                "description": "Filter tests by destination (phone number, webhook URL, etc.)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Retrieves a paginated list of assistant tests with optional filtering capabilities"
        },
        {
          "info": {
            "name": "Create a new assistant test",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a comprehensive test configuration for evaluating AI assistant performance"
        },
        {
          "info": {
            "name": "Get all test suite names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites"
          },
          "docs": "Retrieves a list of all distinct test suite names available to the current user"
        },
        {
          "info": {
            "name": "Get test suite run history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites/:suite_name/runs",
            "params": [
              {
                "name": "suite_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter runs by execution status (pending, running, completed, failed, timeout)"
              },
              {
                "name": "test_suite_run_id",
                "value": "",
                "type": "query",
                "description": "Filter runs by specific suite execution batch ID"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Retrieves paginated history of test runs for a specific test suite with filtering options"
        },
        {
          "info": {
            "name": "Trigger test suite execution",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites/:suite_name/runs",
            "params": [
              {
                "name": "suite_name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes all tests within a specific test suite as a batch operation"
        },
        {
          "info": {
            "name": "Get assistant test by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific assistant test"
        },
        {
          "info": {
            "name": "Update an assistant test",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing assistant test configuration with new settings"
        },
        {
          "info": {
            "name": "Delete an assistant test",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Permanently removes an assistant test and all associated data"
        },
        {
          "info": {
            "name": "Get test run history for a specific test",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter runs by execution status (pending, running, completed, failed, timeout)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Retrieves paginated execution history for a specific assistant test with filtering options"
        },
        {
          "info": {
            "name": "Trigger a manual test run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates immediate execution of a specific assistant test"
        },
        {
          "info": {
            "name": "Get specific test run details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs/:run_id",
            "params": [
              {
                "name": "test_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific test run execution"
        },
        {
          "info": {
            "name": "Get an assistant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "fetch_dynamic_variables_from_webhook",
                "value": "",
                "type": "query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query"
              },
              {
                "name": "to",
                "value": "",
                "type": "query"
              },
              {
                "name": "call_control_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve an AI Assistant configuration by `assistant_id`."
        },
        {
          "info": {
            "name": "Update an assistant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an AI Assistant's attributes."
        },
        {
          "info": {
            "name": "Delete an assistant",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete an AI Assistant by `assistant_id`."
        },
        {
          "info": {
            "name": "Get Canary Deploy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Endpoint to get a canary deploy configuration for an assistant.\n\nRetrieves the current canary deploy configuration with all version IDs and their\ntraffic percentages for the specified assistant."
        },
        {
          "info": {
            "name": "Create Canary Deploy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Endpoint to create a canary deploy configuration for an assistant.\n\nCreates a new canary deploy configuration with multiple version IDs and their traffic\npercentages for A/B testing or gradual rollouts of assistant versions."
        },
        {
          "info": {
            "name": "Update Canary Deploy",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Endpoint to update a canary deploy configuration for an assistant.\n\nUpdates the existing canary deploy configuration with new version IDs and percentages.\n  All old versions and percentages are replaces by new ones from this request."
        },
        {
          "info": {
            "name": "Delete Canary Deploy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Endpoint to delete a canary deploy configuration for an assistant.\n\nRemoves all canary deploy configurations for the specified assistant."
        },
        {
          "info": {
            "name": "Assistant Chat (BETA)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/chat",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows a client to send a chat message to a specific AI Assistant. The assistant processes the message and returns a relevant reply based on the current conversation context. Refer to the Conversation API to [create a conversation](https://developers.telnyx.com/api-reference/conversations/create-a-conversation), [filter existing conversations](https://developers.telnyx.com/api-reference/conversations/list-conversations), [fetch messages for a conversation](https://developers.telnyx"
        },
        {
          "info": {
            "name": "Assistant Sms Chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/chat/sms",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send an SMS message for an assistant. This endpoint: \n1. Validates the assistant exists and has messaging profile configured \n2. If should_create_conversation is true, creates a new conversation with metadata \n3. Sends the SMS message (If `text` is set, this will be sent. Otherwise, if this is the first message in the conversation and the assistant has a `greeting` configured, this will be sent. Otherwise the assistant will generate the text to send.) \n4. Updates conversation metadata if provide"
        },
        {
          "info": {
            "name": "Clone Assistant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/clone",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Clone an existing assistant, excluding telephony and messaging settings."
        },
        {
          "info": {
            "name": "List scheduled events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "from_date",
                "value": "",
                "type": "query"
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query"
              },
              {
                "name": "conversation_channel",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Get scheduled events for an assistant with pagination and filtering"
        },
        {
          "info": {
            "name": "Create a scheduled event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a scheduled event for an assistant"
        },
        {
          "info": {
            "name": "Get a scheduled event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events/:event_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "event_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a scheduled event by event ID"
        },
        {
          "info": {
            "name": "Delete a scheduled event",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events/:event_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "event_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event."
        },
        {
          "info": {
            "name": "Add Assistant Tag",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tags",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add Assistant Tag"
        },
        {
          "info": {
            "name": "Remove Assistant Tag",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tags/:tag",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "tag",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove Assistant Tag"
        },
        {
          "info": {
            "name": "Get assistant texml",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/texml",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get an assistant texml by `assistant_id`."
        },
        {
          "info": {
            "name": "Add Assistant Tool",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Add Assistant Tool"
        },
        {
          "info": {
            "name": "Remove Assistant Tool",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove Assistant Tool"
        },
        {
          "info": {
            "name": "Test Assistant Tool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id/test",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Test a webhook tool for an assistant"
        },
        {
          "info": {
            "name": "Get all versions of an assistant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves all versions of a specific assistant with complete configuration and metadata"
        },
        {
          "info": {
            "name": "Get a specific assistant version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include_mcp_servers",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a specific version of an assistant by assistant_id and version_id"
        },
        {
          "info": {
            "name": "Update a specific assistant version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the configuration of a specific assistant version. Can not update main version"
        },
        {
          "info": {
            "name": "Delete a specific assistant version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Permanently removes a specific version of an assistant. Can not delete main version"
        },
        {
          "info": {
            "name": "Promote an assistant version to main",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id/promote",
            "params": [
              {
                "name": "assistant_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Promotes a specific version to be the main/current version of the assistant. This will delete any existing canary deploy configuration and send all live production traffic to this version."
        },
        {
          "info": {
            "name": "List Tools",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/tools",
            "params": [
              {
                "name": "filter[type]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[name]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List Tools"
        },
        {
          "info": {
            "name": "Create Tool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/ai/tools",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create Tool"
        },
        {
          "info": {
            "name": "Get Tool",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/ai/tools/:tool_id",
            "params": [
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Tool"
        },
        {
          "info": {
            "name": "Update Tool",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/ai/tools/:tool_id",
            "params": [
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Tool"
        },
        {
          "info": {
            "name": "Delete Tool",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/ai/tools/:tool_id",
            "params": [
              {
                "name": "tool_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete Tool"
        }
      ]
    }
  ],
  "bundled": true
}