How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignalWire AI Chat API

Endpoints related to holding a text conversation with an AI agent

SignalWire AI Chat API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AI Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{space_name}.signalwire.com.

1 operations 1 paths 21 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{space_name}.signalwire.com
Authentication
HTTP Basic, HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

SignalWire AI Chat API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (SignalWireBasicAuth). It accepts HTTP bearer tokens (SignalWireBearerAuth). By default, every request must be authenticated.

  • SignalWireBasicAuth — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…
  • SignalWireBearerAuth — SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

AI Chat 1

Endpoints related to holding a text conversation with an AI agent

POST
/api/ai/chat
Send AI chat methods
chat_methods body → 200400401502

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Types.StatusCodes.RestApiErrorItem (5 properties), AI.ChatEndConversationRequest (4 properties), AI.ChatDeleteRequest (4 properties), AI.ChatLogRequest (4 properties). Each schema is shown below with its type and property counts.

AI.ChatConversationEndedResponse
object
3 properties 3 required
AI.ChatErrorResponse
object
A JSON-RPC method failure returned under HTTP 200. After confirming the HTTP status, inspect the envelope for this error member.
3 properties 3 required
AI.ChatErrorCode
number
Why a method failed. -32600 and below are the standard JSON-RPC codes; the rest are specific to AI chat. See [API error codes](/docs/apis/error-codes) for the…
AI.ChatCreateConversationRequest
object
4 properties 4 required
Webhooks.AI.AICallLogEntry
object
One entry in the conversation. Beyond role and content, an entry carries whatever per-turn detail applies to it, such as recognition confidence on a caller tur…
4 properties 2 required
AI.ChatTranscriptResponse
object
3 properties 3 required
AI.ChatEndConversationRequest
object
4 properties 4 required
AI.ChatError
object
A JSON-RPC error returned for the requested method.
2 properties 2 required
AI.ChatDeleteRequest
object
4 properties 4 required
AI.ChatLogRequest
object
4 properties 4 required
AI.ChatRequest
object
A JSON-RPC request. The method field selects which of the six methods runs, and params carries that method's arguments. Authenticate with HTTP Basic authentica…
AI.ChatServiceUnavailableError
object
The AI chat service did not respond before the request timed out or could not be reached. This is not a JSON-RPC error and carries no code.
1 property 1 required
Types.StatusCodes.RestApiErrorItem
object
Details about a specific error.
5 properties 4 required
AI.ChatConversationCreatedResponse
object
3 properties 3 required
AI.ChatResponse
A JSON-RPC response. Which result you get follows from the method you sent; a response echoes no method of its own. Check the HTTP status first. On HTTP 200, i…
AI.ChatSummarizeRequest
object
4 properties 4 required
AI.ChatConversationDeletedResponse
object
3 properties 3 required
AI.ChatReplyResponse
object
3 properties 3 required
AI.ChatInvalidJsonError
object
The request body was not valid JSON. The response is not a JSON-RPC envelope.
1 property 1 required
AI.ChatSummaryResponse
object
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 retur…
3 properties 3 required
AI.ChatSendMessageRequest
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-ai-chat-api-openapi.yml Raw ↑

Other APIs SignalWire publishes across the network.

SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Calls API
SignalWire Campaign Registry: Brands API
Where this information came from

This is an independent, third-party profile of SignalWire AI Chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.