Stream Chat API
Stream Chat API endpoints from Stream Io Api
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Stream Chat API endpoints from Stream Io Api
Endpoints 116
Settings
- GETGet App Settings
/appThis method returns the application settings - PATCHUpdate App Settings
/appThis method updates one or more application settings - GETList block lists
/blocklistsReturns all available block lists - POSTCreate block list
/blocklistsCreates a new application blocklist, once created the blocklist can be used by any channel type - GETGet block list
/blocklists/:nameReturns block list by given name - PUTUpdate block list
/blocklists/:nameUpdates contents of the block list - DELETEDelete block list
/blocklists/:nameDeletes previously created application blocklist - GETList channel types
/channeltypesLists all available channel types - POSTCreate channel type
/channeltypesCreates new channel type - GETGet channel type
/channeltypes/:nameGets channel type - PUTUpdate channel type
/channeltypes/:nameUpdates channel type - DELETEDelete channel type
/channeltypes/:nameDeletes channel type - POSTCheck push
/check_pushSends a test message via push, this is a test endpoint to verify your push settings - POSTCheck SQS
/check_sqsValidates Amazon SQS credentials - GETGet rate limits
/rate_limits?server_side=&android=&ios=&web=&endpoints=Get rate limits usage and quotas
Campaigns
- GETQuery campaigns
/campaigns?payload=Query campaigns - POSTCreate campaign
/campaignsCreates a new campaign - PUTUpdate campaign
/campaigns/:idUpdate an existing campaign - DELETEDelete campaign
/campaigns/:id?recipients=Delete a campaign - PATCHResume campaign
/campaigns/:id/resumeResume a stopped campaign - PATCHSchedule campaign
/campaigns/:id/scheduleSchedule a campaign - PATCHStop campaign
/campaigns/:id/stopStop a running campaign - POSTTest campaign
/campaigns/:id/testTest a campaign - GETQuery recipients
/recipients?payload=Query recipients - GETQuery segments
/segments?payload=Query segments - POSTCreate segment
/segmentsCreate a segment - PUTUpdate segment
/segments/:idUpdate an existing segment - DELETEDelete segment
/segments/:idDelete a segment
Channels
- POSTQuery channels
/channels?client_id=&connection_id=Query channels with filter query - POSTDeletes channels asynchronously
/channels/deleteAllows to delete several channels at once asynchronously - POSTMark channels as read
/channels/readMarks channels as read up to the specific message. If no channels is given, mark all channel as read - POSTGet or create channel (type)
/channels/:type/query?client_id=&connection_id=This method creates a channel or returns an existing one with matching attributes - POSTUpdate channel
/channels/:type/:idChange channel data - DELETEDelete channel
/channels/:type/:id?hard_delete=Deletes channel - PATCHPartially update channel
/channels/:type/:idUpdates certain fields of the channel - POSTHide channel
/channels/:type/:id/hideMarks channel as hidden for current user - POSTGet or create channel (type, id)
/channels/:type/:id/query?client_id=&connection_id=This method creates a channel or returns an existing one with matching attributes - POSTMark read
/channels/:type/:id/readMarks channel as read up to the specific message - POSTShow channel
/channels/:type/:id/showShows previously hidden channel - POSTStop watching channel
/channels/:type/:id/stop-watching?client_id=&connection_id=Call this method to stop receiving channel events - POSTTruncate channel
/channels/:type/:id/truncateTruncates channel - POSTMark unread
/channels/:type/:id/unreadMarks channel as unread from a specific message - POSTExport channels
/export_channelsExports channel data to JSON file - GETExport channels status
/export_channels/:id - GETQuery members
/members?payload=Find and filter channel members - POSTMute channel
/moderation/mute/channelMutes channel for user - POSTUnmute channel
/moderation/unmute/channelUnmutes channel for user - GETSearch messages
/search?payload=Search messages across channels - POSTSync
/sync?with_inaccessible_cids=&watch=&client_id=&connection_id=Returns all events happened since client disconnect in specified channels
Events
- POSTSend event
/channels/:type/:id/eventSends event to the channel - POSTSend user event
/users/:user_id/eventSends a custom event to a user
Messages
- POSTUpload file
/channels/:type/:id/fileUploads file - DELETEDelete file
/channels/:type/:id/file?url=Deletes previously uploaded file - POSTUpload image
/channels/:type/:id/imageUploads image - DELETEDelete image
/channels/:type/:id/image?url=Deletes previously uploaded image - POSTSend new message
/channels/:type/:id/messageSends new message to the specified channel - GETGet many messages
/channels/:type/:id/messages?ids=Returns list messages found by IDs - GETGet message
/messages/:idReturns message by ID - PUTPartially message update
/messages/:idUpdates certain fields of the message - POSTUpdate message
/messages/:idUpdates message with new data - DELETEDelete message
/messages/:id?hard=Deletes message - POSTRun message command action
/messages/:id/actionExecutes message command action with given parameters - POSTSend reaction
/messages/:id/reactionSends reaction to specified message - DELETEDelete reaction
/messages/:id/reaction/:type?user_id=Removes user reaction from the message - GETGet reactions
/messages/:id/reactions?limit=&offset=Returns list of reactions of specific message - POSTTranslate message
/messages/:id/translateTranslates message to a given language using automated translation software - GETGet replies
/messages/:parent_id/replies?id_gte=&id_gt=&id_lte=&id_lt=&created_at_after_or_equal=&created_at_after=&created_at_before_or_equal=&created_at_before=&id_around=&created_at_around=Returns replies (thread) of the message - GETQuery Message Flags
/moderation/flags/message?payload=Find and filter message flags - GETGet OG
/og?url=Get an OpenGraph attachment for a link
Custom commands
- GETList commands
/commandsReturns all custom commands - POSTCreate command
/commandsCreates custom chat command - GETGet command
/commands/:nameReturns custom command by its name - PUTUpdate command
/commands/:nameUpdates custom chat command - DELETEDelete command
/commands/:nameDeletes custom chat command
Users
- GETConnect (WebSocket)
/connect?json=Establishes WebSocket connection for user - POSTExport users
/export/usersExports user profile, reactions and messages for list of given users - POSTCreate guest
/guestCreates guest user - GETLong Poll (Transport)
/longpoll?json=&connection_id=WebSocket fallback transport endpoint - POSTBan user
/moderation/banRestricts user activity either in specific channel or globally - DELETEUnban user
/moderation/ban?target_user_id=&type=&id=Removes previously applied ban - POSTMute user
/moderation/muteMutes one or several users - POSTUnmute user
/moderation/unmuteUnmutes previously muted user - GETQuery Banned Users
/query_banned_users?payload=Find and filter channel scoped or global user bans - GETQuery users
/users?payload=Find and filter users - POSTUpsert users
/usersUpdate or create users in bulk - PATCHPartially update user
/usersUpdates certain fields of the user - POSTDeactivate users
/users/deactivateDeactivate users in batches - POSTDelete Users
/users/deleteDeletes users and optionally all their belongings asynchronously. - POSTReactivate users
/users/reactivateReactivate users in batches - POSTRestore users
/users/restoreRestore soft deleted users - DELETEDelete user
/users/:user_id?mark_messages_deleted=&hard_delete=&delete_conversation_channels=Deletes user and optionally all their belongings. The Endpoint is deprecated, please use 'Delete Users' endpoint instead - POSTDeactivate user
/users/:user_id/deactivateDeactivates user with possibility to activate it back - GETExport user
/users/:user_id/exportExports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions - POSTReactivate user
/users/:user_id/reactivateActivates user who's been deactivated previously
Devices
- GETList devices
/devices?user_id=Returns all available devices - POSTCreate device
/devicesAdds a new device to a user, if the same device already exists the call will have no effect - DELETEDelete device
/devices?id=&user_id=Deletes device
Imports
- POSTCreate import URL
/import_urlsCreates a new import URL - GETGet import
/importsGets an import - POSTCreate import
/importsCreates a new import - GETGet import
/imports/:idGets an import
Moderation
- POSTFlag
/moderation/flagReports message or user for review by moderators - POSTUnflag
/moderation/unflagRemoves previously created user or message flag
Permissions V2
- GETList permissions
/permissionsLists all available permissions - GETGet permission
/permissions/:idGets custom permission - GETList roles
/rolesLists all available roles - POSTCreate role
/rolesCreates custom role - DELETEDelete role
/roles/:nameDeletes custom role
Push
- GETList push providers
/push_providersList details of all push providers. - POSTUpsert a push provider
/push_providersUpsert a push provider for v2 with multi bundle/package support - DELETEDelete a push provider
/push_providers/:type/:nameDelete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint
Tasks
- GETGet status of a task
/tasks/:idGets status of a task
- POSTGet Call Token ()
/calls/Retrieves the token to join a call - POSTGet Call Token (call_id)
/calls/:call_idRetrieves the token to join a call - POSTCreate a call
/channels/:type/:id/callCreates a call - POSTCommit message
/messages/:id/commitCommits a pending message, which will make it visible in the channel
API details
- Base URL
https://chat.stream-io-api.comhttp://localhost:{port}- Authentication
- An API key in the Authorization header
An API key in the api_key query parameter
An API key in the Stream-Auth-Type header - Operations
- 116 operations on 87 pathsPOST 56GET 33DELETE 15PUT 6PATCH 6
- Main resources
- Messages 24Users 22Channels 21Moderation 19Settings 18Campaigns 13GDPR 7Channel types 5Custom commands 5Permissions V2 5
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
v79.19.1 - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Stream Chat API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Stream Chat API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get App Settings” (GET /app), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Stream Chat API?
Stream Chat API endpoints from Stream Io Api It is listed under Other and has 116 endpoints.
Who publishes the Stream Chat API?
It is listed from Stream Io Api's public API description (an OpenAPI document), not published by Stream Io Api on Swastik Codes. Anyone who controls stream-io-api.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Stream Chat API?
Its description lists 2 base URLs: https://chat.stream-io-api.com, http://localhost:{port}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Stream Chat API?
It accepts 3 methods: an API key in the Authorization header; an API key in the api_key query parameter; an API key in the Stream-Auth-Type header.
How many endpoints does the Stream Chat API have?
116 operations on 87 paths (56 POST, 33 GET, 15 DELETE, 6 PUT, 6 PATCH). The largest groups are Messages, Users, Channels, Moderation.
Is forking the Stream Chat API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.