# Chatway API

**Canonical:** https://apis.io/apis/chatway-app/chatway-app-api/  
**Provider:** Chatway — https://apis.io/providers/chatway-app/  
**Documentation:** https://developers.chatway.app/operations/guides.quickstart

Chatway API is one of 2 APIs that [Chatway](https://apis.io/providers/chatway-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Chatway API as documented publicly: 21 operations. Contract generated from the documentation by API Evangelist (2026-11-04); not the provider's own document.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/.well-known/agent-skills/index.json` | GET /.well-known/agent-skills/index.json |
| GET | `/.well-known/agent-skills/{skill}/SKILL.md` | Get an agent skill |
| GET | `/agents` | List Agents. |
| POST | `/agents/invite` | Invite Agents |
| GET | `/api/v1/agents` | GET /api/v1/agents |
| POST | `/api/v1/agents/invite` | POST /api/v1/agents/invite |
| GET | `/api/v1/agents/{id}` | Get Agent Retrieve one agent's profile, availability and team role. |
| GET | `/api/v1/contacts` | GET /api/v1/contacts |
| POST | `/api/v1/messages` | POST /api/v1/messages |
| POST | `/api/v1/webhooks` | POST /api/v1/webhooks |
| GET | `/api/v1/webhooks/{webhook}` | GET /api/v1/webhooks/{webhook} |
| GET | `/api/v1/widgets` | GET /api/v1/widgets |
| GET | `/auth.md` | Authentication guide - Chatway Developer Docs |
| GET | `/contacts` | Read paginated contacts |
| POST | `/contacts/initialize` | Initialize a contact without using the visitor-message workflow with POST /contacts/initialize . This operation spells the widget parameter widgetId . |
| POST | `/conversations` | Send as a visitor with Create Visitor Message : POST /conversations requires widget_id and content , and selects or creates the contact and conversation. |
| GET | `/conversations/all` | You do not need to call GET /conversations/all first if you already have data.conversation.id from the webhook. |
| GET | `/conversations/{id}/messages` | List messages for a conversation |
| POST | `/conversations/{id}/resolve` | Resolve a conversation |
| POST | `/messages` | Send a reply to a conversation via POST /messages. |
| GET | `/widgets` | Read widget list |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/chatway-app/openapi/_ae-authored/chatway-app-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-get-api-v1-agents-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-get-api-v1-agents-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-post-agents-invite-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-post-messages-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-get-well-known-agent-skills-index-json-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatway-app/json-schema/chatway-app-post-api-v1-webhooks-response-schema.json

## Other Chatway APIs (1)

- [Chatway REST API](https://apis.io/apis/chatway-app/chatway-rest-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/chatway-app/chatway-app-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/chatway-app/.