Getstream Stream API

Name: Stream API
Brand: Stream API
Availability: InStock

✓ Official Vendor SpecCommunicationsChat MessagingapiKey171 EndpointsREST

For Agents

Send messages, manage channels, moderate content, and run chat campaigns through Stream's chat infrastructure. Supports per-user JWT tokens, blocklists, and reactions across 171 endpoints.

Install Jentic One Beta

Connect the Stream API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Stream API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Stream API.

Create and update chat channels with custom roles, members, and metadata

Send messages with attachments, reactions, threads, and read receipts

Issue per-user JWT tokens to scope chat access to a single user session

GET STARTED

Start building with Stream API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Stream API for, with concrete tasks.

★ In-App Chat for Consumer Products

Embed direct messaging and group chat into mobile or web apps with channels, threads, reactions, typing indicators, and read state. Stream handles message storage, fan-out, and delivery so product teams ship a working chat experience in days instead of building real-time infrastructure from scratch. The API issues per-user JWT tokens so each client only accesses its own channels.

Create a messaging channel between users alice and bob, issue a JWT for alice, then send the message 'Hi from the agent' on her behalf.

Community and Support Channels

Run public community channels, support rooms, or moderated group chats with role-based permissions, blocklists, and AI moderation. The Stream API exposes blocklist CRUD and campaign endpoints so moderation teams can enforce content rules and broadcast announcements across many channels at once.

Add the term 'spam-domain.example' to the global blocklist and confirm the moderation rule is active for all channels.

Customer Engagement Campaigns

Send targeted in-chat campaigns to user segments using the campaigns endpoints. Marketing or lifecycle teams query users by attribute, schedule the campaign, and Stream delivers messages through the existing chat channel without the user installing anything new. Useful for re-engagement, product announcements, and onboarding nudges.

Start campaign id 'camp_welcome_2026' and verify it transitioned to status 'running'.

AI Agent Chat Workflows

AI agents act as a participant in Stream channels - reading recent messages, generating a response, and posting back through the same channel. Through Jentic the agent searches for the send-message operation, loads the schema, and executes with a JWT scoped to the agent user, so the raw Stream secret never enters the agent's context.

Read the last 20 messages in channel 'support-123', generate a reply, and post it as user 'agent-bot'.

Key Endpoints

171 endpoints — the stream api powers in-app chat, channels, messages, reactions, threads, moderation, and activity feeds for consumer and saas products.

METHOD

PATH

DESCRIPTION

POST

/channels

Query channels by filter and sort

GET

/app

Get app settings and configuration

POST

/blocklists

Create a blocklist of banned words

POST

/campaigns/{id}/start

Start a chat campaign

POST

/campaigns/{id}/stop

Stop a running campaign

GET

/blocklists

List all blocklists in the app

POST

/channels

Query channels by filter and sort

GET

/app

Get app settings and configuration

POST

/blocklists

Create a blocklist of banned words

POST

/campaigns/{id}/start

Start a chat campaign

POST

/campaigns/{id}/stop

Stop a running campaign

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Stream app secret is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'send a chat message' or 'add a term to a blocklist', and Jentic returns the matching Stream operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Stream API through Jentic.

What authentication does the Stream API use?

Stream uses an apiKey scheme - a per-user JWT passed in the Authorization header, plus a server-side api_key query parameter and Stream-Auth-Type header. Through Jentic these credentials live in the encrypted vault and never enter the agent's context, so the agent only receives a scoped token at execution time.

Can I send a chat message with the Stream API?

Yes. The send-message operation under the channels resource accepts a channel id and a message body and returns the persisted message with id, created_at, and reactions. The spec exposes channel querying via POST /channels and channel-scoped message endpoints under the same resource.

What are the rate limits for the Stream API?

Stream applies per-app rate limits that vary by endpoint family - channel and message reads have higher limits than campaign or moderation writes. Specific quotas depend on the plan; production apps should implement exponential backoff on 429 responses and check the X-Ratelimit-Remaining header.

How do I moderate messages with the Stream API through Jentic?

Search Jentic for 'add a word to the chat blocklist'. Jentic returns the POST /blocklists operation with its schema; load it, supply the blocklist name and words, and execute. Stream then applies the rule across all channels in the app.

Can the Stream API run chat campaigns?

Yes. POST /campaigns/{id}/start launches a configured campaign and POST /campaigns/{id}/stop halts it. POST /campaigns/query lists campaigns with filters so you can find one by status or creation date before transitioning state.

Does Stream support push notifications?

Yes. The API exposes device registration and push provider configuration so registered devices receive a push when a message arrives in a channel they belong to. Notification templates can be customised per channel type.

Can I limit what my agent is allowed to do with the Stream API?

Yes. Because Jentic One is self-hosted, your own rules decide which Stream operations and credentials your agent may use. Stream puts the campaign id in the URL path (POST /campaigns/{id}/start and POST /campaigns/{id}/stop), so you can pin the agent to a single campaign for start and stop actions. Wider operations, such as editing app settings or managing blocklists, are not available to the agent unless you explicitly add them.

Getstream Stream API

Connect the Stream API to your agent

Capabilities

Start building with Stream API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs