Send AI chat methods

Hold a text conversation with an AI agent. All six methods travel over this endpoint in a JSON-RPC 2.0 body. Put the method name in method and its arguments in params.

Your agent is an SWML document you serve, and config_url is where you serve it. A conversation is a series of turns addressed by an id you choose. A turn is one user message and the agent’s reply, including any tool calls made along the way. One request runs one turn.

Methods

Method	Description
`create_conversation`	Create a conversation, or reset an existing one
`chat`	Send a message and receive the agent’s reply
`end_conversation`	End the conversation and trigger post-processing
`delete`	Remove the conversation, with no post-processing
`chat_log`	Read the conversation back
`summarize`	Generate a summary on demand

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Chat.

Learn more about API scopes.

Hold a text conversation with an AI agent. All six methods travel over this endpoint in a JSON-RPC 2.0 body. Put the method name in `method` and its arguments in `params`. Your agent is an SWML document you serve, and `config_url` is where you serve it. A conversation is a series of turns addressed by an `id` you choose. A turn is one user message and the agent's reply, including any tool calls made along the way. One request runs one turn. ## Methods | Method | Description | |---|---| | `create_conversation` | Create a conversation, or reset an existing one | | `chat` | Send a message and receive the agent's reply | | `end_conversation` | End the conversation and trigger post-processing | | `delete` | Remove the conversation, with no post-processing | | `chat_log` | Read the conversation back | | `summarize` | Generate a summary on demand | #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Chat_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.

create_conversationobjectRequired

chatobjectRequired

end_conversationobjectRequired

deleteobjectRequired

chat_logobjectRequired

summarizeobjectRequired

Response

The request has succeeded.

create_conversation resultobject

chat resultobject

end_conversation resultobject

delete resultobject

chat_log resultobject

summarize resultobject

The result of requesting a summary. A generated summary is returned in summary. If summary generation fails after the request succeeds, the reason can be returned in error; this is not a JSON-RPC error and carries no code.

Errorobject

A JSON-RPC method failure returned under HTTP 200. After confirming the HTTP status, inspect the envelope for this error member.

Errors

400

Bad Request Error

401

Unauthorized Error

502

Bad Gateway Error