# Stream product:chat API

**Canonical:** https://apis.io/apis/getstream/stream-io-product-chat-api/  
**Provider:** Stream — https://apis.io/providers/getstream/  
**Base URL:** https://chat.stream-io-api.com  
**Documentation:** https://getstream.io/chat/docs/

Stream product:chat API is one of 19 APIs that [Stream](https://apis.io/providers/getstream/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. Tagged areas include product:chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

The product:chat API from Stream — 194 operation(s) for product:chat.

## Operations (60 of 269)

| Method | Path | Summary |
|---|---|---|
| GET | `/app` | Get App Settings |
| PATCH | `/app` | Update App Settings |
| GET | `/blocklists` | List block lists |
| POST | `/blocklists` | Create block list |
| DELETE | `/blocklists/{name}` | Delete block list |
| GET | `/blocklists/{name}` | Get block list |
| PUT | `/blocklists/{name}` | Update block list |
| POST | `/campaigns` | Create campaign |
| DELETE | `/campaigns/{id}` | Delete campaign |
| GET | `/campaigns/{id}` | Get campaign |
| PUT | `/campaigns/{id}` | Update campaign |
| POST | `/campaigns/{id}/start` | Start/schedule campaign |
| POST | `/campaigns/{id}/stop` | Stop campaign |
| POST | `/campaigns/query` | Query campaigns |
| POST | `/channels` | Query channels |
| DELETE | `/channels/{type}/{id}` | Delete channel |
| PATCH | `/channels/{type}/{id}` | Partially update channel |
| POST | `/channels/{type}/{id}` | Update channel |
| DELETE | `/channels/{type}/{id}/draft` | Delete draft |
| GET | `/channels/{type}/{id}/draft` | Get draft |
| POST | `/channels/{type}/{id}/event` | Send event |
| DELETE | `/channels/{type}/{id}/file` | Delete file |
| POST | `/channels/{type}/{id}/file` | Upload file |
| POST | `/channels/{type}/{id}/hide` | Hide channel |
| DELETE | `/channels/{type}/{id}/image` | Delete image |
| POST | `/channels/{type}/{id}/image` | Upload image |
| PATCH | `/channels/{type}/{id}/member` | Partially channel member update |
| POST | `/channels/{type}/{id}/message` | Send new message |
| GET | `/channels/{type}/{id}/messages` | Get many messages |
| POST | `/channels/{type}/{id}/query` | Get or create channel |
| POST | `/channels/{type}/{id}/read` | Mark read |
| POST | `/channels/{type}/{id}/show` | Show channel |
| POST | `/channels/{type}/{id}/truncate` | Truncate channel |
| POST | `/channels/{type}/{id}/unread` | Mark unread |
| POST | `/channels/{type}/query` | Get or create channel |
| PUT | `/channels/batch` | Update channels in batch |
| POST | `/channels/delete` | Deletes channels asynchronously |
| POST | `/channels/delivered` | Mark channel message delivery status |
| POST | `/channels/grouped` | Grouped query channels |
| POST | `/channels/read` | Mark channels as read |
| GET | `/channeltypes` | List channel types |
| POST | `/channeltypes` | Create channel type |
| DELETE | `/channeltypes/{name}` | Delete channel type |
| GET | `/channeltypes/{name}` | Get channel type |
| PUT | `/channeltypes/{name}` | Update channel type |
| POST | `/check_push` | Check push |
| POST | `/check_sns` | Check SNS |
| POST | `/check_sqs` | Check SQS |
| GET | `/commands` | List commands |
| POST | `/commands` | Create command |
| DELETE | `/commands/{name}` | Delete command |
| GET | `/commands/{name}` | Get command |
| PUT | `/commands/{name}` | Update command |
| DELETE | `/devices` | Delete device |
| GET | `/devices` | List devices |
| POST | `/devices` | Create device |
| POST | `/drafts/query` | Query draft messages |
| POST | `/export/users` | Export users |
| POST | `/export_channels` | Export channels |
| GET | `/external_storage` | List external storage |

…and 209 more operations. The page lists the first 250; the full set of 269 is in the OpenAPI linked below.

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/getstream/refs/heads/main/openapi/stream-io-product-chat-api-openapi.yml
- **Documentation** — https://getstream.io/chat/docs/
- **APIReference** — https://getstream.github.io/protocol/?urls.primaryName=Chat
- **OpenAPISource** — https://raw.githubusercontent.com/GetStream/protocol/main/openapi/chat-openapi.yaml
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/getstream/refs/heads/main/asyncapi/stream-io-asyncapi.yml
- **SDKs** — https://getstream.io/chat/sdk/
- **Documentation** — https://getstream.io/video/docs/
- **APIReference** — https://getstream.github.io/protocol/?urls.primaryName=Video
- **OpenAPISource** — https://raw.githubusercontent.com/GetStream/protocol/main/openapi/video-openapi.yaml
- **SDKs** — https://getstream.io/video/sdk/
- **Documentation** — https://getstream.io/moderation/docs/
- **OpenAPISource** — https://raw.githubusercontent.com/GetStream/protocol/main/openapi/moderation-openapi.yaml

## Other Stream APIs (12)

- [Stream Activity Feeds API](https://apis.io/apis/getstream/getstream-activity-feeds-api/)
- [Stream Video and Audio API](https://apis.io/apis/getstream/getstream-video-audio-api/)
- [Stream Application API](https://apis.io/apis/getstream/getstream-application-api/)
- [Stream Campaigns API](https://apis.io/apis/getstream/getstream-campaigns-api/)
- [Stream Channels API](https://apis.io/apis/getstream/getstream-channels-api/)
- [Stream Devices API](https://apis.io/apis/getstream/getstream-devices-api/)
- [Stream Members API](https://apis.io/apis/getstream/getstream-members-api/)
- [Stream Messages API](https://apis.io/apis/getstream/getstream-messages-api/)
- [Stream Moderation API](https://apis.io/apis/getstream/getstream-moderation-api/)
- [Stream Permissions API](https://apis.io/apis/getstream/getstream-permissions-api/)
- [Stream Reactions API](https://apis.io/apis/getstream/getstream-reactions-api/)
- [Stream Roles API](https://apis.io/apis/getstream/getstream-roles-api/)

## Tags

product:chat

---

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