Stream Chat API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://chat.stream-io-api.com http://localhost:{port}
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Stream Chat API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /app | Get App Settings This method returns the application settings Settings |
PATCH | /app | Update App Settings This method updates one or more application settings Settings |
GET | /blocklists | List block lists Returns all available block lists Settings Moderation |
POST | /blocklists | Create block list Creates a new application blocklist, once created the blocklist can be used by any channel t |
GET | /blocklists/{name} | Get block list Returns block list by given name Settings Moderation |
PUT | /blocklists/{name} | Update block list Updates contents of the block list Settings Moderation |
DELETE | /blocklists/{name} | Delete block list Deletes previously created application blocklist Settings Moderation |
POST | /calls/ | Get Call Token () Retrieves the token to join a call |
POST | /calls/{call_id} | Get Call Token (call_id) Retrieves the token to join a call |
GET | /campaigns | Query campaigns Query campaigns Campaigns |
POST | /campaigns | Create campaign Creates a new campaign Campaigns |
PUT | /campaigns/{id} | Update campaign Update an existing campaign Campaigns |
DELETE | /campaigns/{id} | Delete campaign Delete a campaign Campaigns |
PATCH | /campaigns/{id}/resume | Resume campaign Resume a stopped campaign Campaigns |
PATCH | /campaigns/{id}/schedule | Schedule campaign Schedule a campaign Campaigns |
PATCH | /campaigns/{id}/stop | Stop campaign Stop a running campaign Campaigns |
POST | /campaigns/{id}/test | Test campaign Test a campaign Campaigns |
POST | /channels | Query channels Query channels with filter query Channels |
POST | /channels/delete | Deletes channels asynchronously Allows to delete several channels at once asynchronously Channels GDPR |
POST | /channels/read | Mark channels as read Marks channels as read up to the specific message. If no channels is given, mark all cha |
POST | /channels/{type}/query | Get or create channel (type) This method creates a channel or returns an existing one with matching attributes |
POST | /channels/{type}/{id} | Update channel Change channel data Channels |
PATCH | /channels/{type}/{id} | Partially update channel Updates certain fields of the channel Channels |
DELETE | /channels/{type}/{id} | Delete channel Deletes channel Channels |
POST | /channels/{type}/{id}/call | Create a call Creates a call |
POST | /channels/{type}/{id}/event | Send event Sends event to the channel Events |
POST | /channels/{type}/{id}/file | Upload file Uploads file Messages Files |
DELETE | /channels/{type}/{id}/file | Delete file Deletes previously uploaded file Messages Files |
POST | /channels/{type}/{id}/hide | Hide channel Marks channel as hidden for current user Channels |
POST | /channels/{type}/{id}/image | Upload image Uploads image Messages Files |
DELETE | /channels/{type}/{id}/image | Delete image Deletes previously uploaded image Messages Files |
POST | /channels/{type}/{id}/message | Send new message Sends new message to the specified channel Messages |
GET | /channels/{type}/{id}/messages | Get many messages Returns list messages found by IDs Messages |
POST | /channels/{type}/{id}/query | Get or create channel (type, id) This method creates a channel or returns an existing one with matching attrib |
POST | /channels/{type}/{id}/read | Mark read Marks channel as read up to the specific message Channels Messages |
POST | /channels/{type}/{id}/show | Show channel Shows previously hidden channel Channels |
POST | /channels/{type}/{id}/stop-watching | Stop watching channel Call this method to stop receiving channel events Channels |
POST | /channels/{type}/{id}/truncate | Truncate channel Truncates channel Channels |
POST | /channels/{type}/{id}/unread | Mark unread Marks channel as unread from a specific message Channels Messages |
GET | /channeltypes | List channel types Lists all available channel types Settings Channel types |
and 76 more operation(s) in this specification, all searchable.
specification origin: https://stream-openapi.s3.us-east-1.amazonaws.com/chat/openapi-latest.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.