Stream API

Stream API

API version: v223.6.0

Auth

ApiKey Authorization in header | ApiKey api_key in query | ApiKey Stream-Auth-Type in header

Base URL

https://chat.stream-io-api.com

Setup

1. Set your API key in the appropriate header
2. GET /app -- verify access
3. POST /blocklists -- create first blocklists

Endpoints

167 endpoints across 41 groups. See references/api-spec.lap for full details.

app

blocklists

campaigns

channels

channeltypes

check_push

check_sns

check_sqs

commands

devices

drafts

export

export_channels

external_storage

guest

import_urls

imports

members

messages

moderation

og

permissions

polls

push_preferences

push_providers

push_templates

query_banned_users

query_future_channel_bans

rate_limits

reminders

roles

search

segments

stats

tasks

threads

unread

unread_batch

uploads

usergroups

users

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all app?" -> GET /app
• "List all blocklists?" -> GET /blocklists
• "Create a blocklist?" -> POST /blocklists
• "Delete a blocklist?" -> DELETE /blocklists/{name}
• "Get blocklist details?" -> GET /blocklists/{name}
• "Update a blocklist?" -> PUT /blocklists/{name}
• "Get campaign details?" -> GET /campaigns/{id}
• "Create a start?" -> POST /campaigns/{id}/start
• "Create a stop?" -> POST /campaigns/{id}/stop
• "Create a query?" -> POST /campaigns/query
• "Create a channel?" -> POST /channels
• "Delete a channel?" -> DELETE /channels/{type}/{id}
• "Partially update a channel?" -> PATCH /channels/{type}/{id}
• "List all draft?" -> GET /channels/{type}/{id}/draft
• "Create a event?" -> POST /channels/{type}/{id}/event
• "Create a file?" -> POST /channels/{type}/{id}/file
• "Create a hide?" -> POST /channels/{type}/{id}/hide
• "Create a image?" -> POST /channels/{type}/{id}/image
• "Create a message?" -> POST /channels/{type}/{id}/message
• "List all messages?" -> GET /channels/{type}/{id}/messages
• "Create a query?" -> POST /channels/{type}/{id}/query
• "Create a read?" -> POST /channels/{type}/{id}/read
• "Create a show?" -> POST /channels/{type}/{id}/show
• "Create a truncate?" -> POST /channels/{type}/{id}/truncate
• "Create a unread?" -> POST /channels/{type}/{id}/unread
• "Create a query?" -> POST /channels/{type}/query
• "Create a delete?" -> POST /channels/delete
• "Create a delivered?" -> POST /channels/delivered
• "Create a read?" -> POST /channels/read
• "List all channeltypes?" -> GET /channeltypes
• "Create a channeltype?" -> POST /channeltypes
• "Delete a channeltype?" -> DELETE /channeltypes/{name}
• "Get channeltype details?" -> GET /channeltypes/{name}
• "Update a channeltype?" -> PUT /channeltypes/{name}
• "Create a check_push?" -> POST /check_push
• "Create a check_sn?" -> POST /check_sns
• "Create a check_sq?" -> POST /check_sqs
• "List all commands?" -> GET /commands
• "Create a command?" -> POST /commands
• "Delete a command?" -> DELETE /commands/{name}
• "Get command details?" -> GET /commands/{name}
• "Update a command?" -> PUT /commands/{name}
• "List all devices?" -> GET /devices
• "Create a device?" -> POST /devices
• "Create a query?" -> POST /drafts/query
• "Create a user?" -> POST /export/users
• "Create a export_channel?" -> POST /export_channels
• "List all external_storage?" -> GET /external_storage
• "Create a external_storage?" -> POST /external_storage
• "Delete a external_storage?" -> DELETE /external_storage/{name}
• "Update a external_storage?" -> PUT /external_storage/{name}
• "List all check?" -> GET /external_storage/{name}/check
• "Create a guest?" -> POST /guest
• "Create a import_url?" -> POST /import_urls
• "List all imports?" -> GET /imports
• "Create a import?" -> POST /imports
• "Get import details?" -> GET /imports/{id}
• "List all imports?" -> GET /imports/v2
• "Create a import?" -> POST /imports/v2
• "Delete a import?" -> DELETE /imports/v2/{id}
• "Get import details?" -> GET /imports/v2/{id}
• "List all members?" -> GET /members
• "Delete a message?" -> DELETE /messages/{id}
• "Get message details?" -> GET /messages/{id}
• "Update a message?" -> PUT /messages/{id}
• "Create a action?" -> POST /messages/{id}/action
• "Create a commit?" -> POST /messages/{id}/commit
• "Create a reaction?" -> POST /messages/{id}/reaction
• "Delete a reaction?" -> DELETE /messages/{id}/reaction/{type}
• "List all reactions?" -> GET /messages/{id}/reactions
• "Create a reaction?" -> POST /messages/{id}/reactions
• "Create a translate?" -> POST /messages/{id}/translate
• "Create a undelete?" -> POST /messages/{id}/undelete
• "Create a vote?" -> POST /messages/{message_id}/polls/{poll_id}/vote
• "Delete a vote?" -> DELETE /messages/{message_id}/polls/{poll_id}/vote/{vote_id}
• "Create a reminder?" -> POST /messages/{message_id}/reminders
• "List all replies?" -> GET /messages/{parent_id}/replies
• "Create a history?" -> POST /messages/history
• "Create a ban?" -> POST /moderation/ban
• "Create a flag?" -> POST /moderation/flag
• "List all message?" -> GET /moderation/flags/message
• "Create a mute?" -> POST /moderation/mute
• "Create a channel?" -> POST /moderation/mute/channel
• "Create a unmute?" -> POST /moderation/unmute
• "Create a channel?" -> POST /moderation/unmute/channel
• "List all og?" -> GET /og
• "List all permissions?" -> GET /permissions
• "Get permission details?" -> GET /permissions/{id}
• "Create a poll?" -> POST /polls
• "Delete a poll?" -> DELETE /polls/{poll_id}
• "Get poll details?" -> GET /polls/{poll_id}
• "Partially update a poll?" -> PATCH /polls/{poll_id}
• "Create a option?" -> POST /polls/{poll_id}/options
• "Delete a option?" -> DELETE /polls/{poll_id}/options/{option_id}
• "Get option details?" -> GET /polls/{poll_id}/options/{option_id}
• "Create a vote?" -> POST /polls/{poll_id}/votes
• "Create a query?" -> POST /polls/query
• "Create a push_preference?" -> POST /push_preferences
• "List all push_providers?" -> GET /push_providers
• "Create a push_provider?" -> POST /push_providers
• "Delete a push_provider?" -> DELETE /push_providers/{type}/{name}
• "List all push_templates?" -> GET /push_templates
• "Create a push_template?" -> POST /push_templates
• "List all query_banned_users?" -> GET /query_banned_users
• "List all query_future_channel_bans?" -> GET /query_future_channel_bans
• "List all rate_limits?" -> GET /rate_limits
• "Create a query?" -> POST /reminders/query
• "List all roles?" -> GET /roles
• "Create a role?" -> POST /roles
• "Delete a role?" -> DELETE /roles/{name}
• "List all search?" -> GET /search
• "Delete a segment?" -> DELETE /segments/{id}
• "Get segment details?" -> GET /segments/{id}
• "Create a deletetarget?" -> POST /segments/{id}/deletetargets
• "Get target details?" -> GET /segments/{id}/target/{target_id}
• "Create a query?" -> POST /segments/{id}/targets/query
• "Create a query?" -> POST /segments/query
• "Create a team_usage?" -> POST /stats/team_usage
• "Get task details?" -> GET /tasks/{id}
• "Create a thread?" -> POST /threads
• "Get thread details?" -> GET /threads/{message_id}
• "Partially update a thread?" -> PATCH /threads/{message_id}
• "List all unread?" -> GET /unread
• "Create a unread_batch?" -> POST /unread_batch
• "Create a file?" -> POST /uploads/file
• "Create a image?" -> POST /uploads/image
• "List all usergroups?" -> GET /usergroups
• "Create a usergroup?" -> POST /usergroups
• "Delete a usergroup?" -> DELETE /usergroups/{id}
• "Get usergroup details?" -> GET /usergroups/{id}
• "Update a usergroup?" -> PUT /usergroups/{id}
• "Create a member?" -> POST /usergroups/{id}/members
• "Search search?" -> GET /usergroups/search
• "List all users?" -> GET /users
• "Create a user?" -> POST /users
• "Create a deactivate?" -> POST /users/{user_id}/deactivate
• "Create a event?" -> POST /users/{user_id}/event
• "List all export?" -> GET /users/{user_id}/export
• "Create a reactivate?" -> POST /users/{user_id}/reactivate
• "List all block?" -> GET /users/block
• "Create a block?" -> POST /users/block
• "Create a deactivate?" -> POST /users/deactivate
• "Create a delete?" -> POST /users/delete
• "List all live_locations?" -> GET /users/live_locations
• "Create a reactivate?" -> POST /users/reactivate
• "Create a restore?" -> POST /users/restore
• "Create a unblock?" -> POST /users/unblock
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP