Clearstream API

Name: Clearstream API API
Brand: Clearstream API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsSms MessagingapiKey17 EndpointsREST

For Agents

Send SMS messages, manage subscribers and lists, configure keyword automations, and read conversation threads on the Clearstream SMS marketing platform.

Connect the Clearstream API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Clearstream 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.

Install Jentic One Beta (Self-Hosted)

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

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 Clearstream API API.

Send or schedule an SMS broadcast to a subscriber list

Manage subscriber records including create, update, and remove operations

Maintain segmented lists used as targets for messages

Send a one-off text message to a specific recipient

GET STARTED

Start building with Clearstream API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Clearstream API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Clearstream API, keeping it validated and agent-ready. Clearstream is an SMS marketing platform aimed at organisations managing subscriber lists, broadcast campaigns, and inbound keyword-driven flows. The API exposes endpoints for managing the account, subscribers, lists, scheduled and immediate messages, keyword automations, ad-hoc texts, and conversation threads. Authentication is by API key sent in the X-Api-Key header.

Use Cases

Patterns agents use Clearstream API API for, with concrete tasks.

★ Scheduled SMS Broadcast Campaign

Schedule an SMS broadcast to a targeted subscriber list for delivery at a future time, for example a Sunday morning service reminder or an event announcement. The API accepts the message body, sender number, target list, and send time, then returns a record that can be retrieved later for delivery confirmation. Lists are managed as first-class resources so the same audience can be reused across campaigns.

Call POST /messages with the list ID, message body, and send_at timestamp to schedule a broadcast SMS to all subscribers on that list.

Subscriber Lifecycle Management

Manage SMS subscribers across signup, list assignment, profile updates, and opt-out. New subscribers are created via POST /subscribers, moved between lists, updated when their phone number or attributes change, and removed when they opt out. This is the backbone of any compliant SMS programme that needs a clean record of who consented to what.

On a webhook unsubscribe event, call DELETE /subscribers/{id} with the subscriber ID to remove them from future broadcasts.

Two-Way SMS Conversations

Read inbound and outbound message threads to follow up on conversations subscribers initiate by replying to broadcasts or texting in keywords. The threads endpoint returns the full message history for review, and POST /texts sends a one-off reply outside of a scheduled campaign. This supports lightweight customer support and pastoral follow-up flows on top of the broadcast model.

Call GET /threads to find unread conversations, then send a personal reply via POST /texts with the recipient number and body.

AI Agent SMS Outreach

Allow an AI agent to run SMS outreach end-to-end through Jentic: sync subscribers from a CRM, create or update lists, schedule a broadcast, and check the resulting threads for replies. The agent searches Jentic by intent rather than browsing Clearstream docs, and the API key remains in the Jentic vault throughout.

Search Jentic for 'send SMS to a list', execute POST /messages to schedule the broadcast, then poll GET /threads for replies and feed them back into the CRM as activities.

Key Endpoints

17 endpoints — jentic publishes the only available openapi specification for clearstream api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/messages

Send or schedule a broadcast SMS

POST

/texts

Send a one-off text message

GET

/subscribers

List all subscribers

POST

/subscribers

Create a subscriber

GET

/lists

List all subscriber lists

POST

/lists

Create a new list

GET

/threads

Read conversation threads

POST

/messages

Send or schedule a broadcast SMS

POST

/texts

Send a one-off text message

GET

/subscribers

List all subscribers

POST

/subscribers

Create a subscriber

GET

/lists

List all subscriber lists

POST

Why though Jentic?

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

Credential isolation

Clearstream API keys are stored encrypted in the Jentic vault. Agents execute SMS operations via Jentic's scoped access — the X-Api-Key value never appears in the agent's prompt or context.

Intent-based discovery

Agents search Jentic with intents like 'send an SMS broadcast' or 'add a subscriber to a list' and receive the matching Clearstream operation with its input schema, ready to execute.

Time to first call

Direct Clearstream integration: 1-2 days to wire auth, list management, broadcast scheduling, and thread polling. Through Jentic: under 30 minutes — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Twilio API

General-purpose SMS, voice, and messaging platform with global carrier coverage.

Choose Twilio when you need broad international reach or programmable voice alongside SMS.

Alternative

Clickatell Platform API

Unified SMS and WhatsApp messaging platform for transactional sends.

Use Clickatell when WhatsApp delivery alongside SMS matters more than list-based marketing features.

Alternative

Plivo API

Programmable SMS and voice with a developer-focused pricing model.

Pick Plivo when low per-message pricing and direct carrier connectivity are the priority.

Alternative

MessageBird API

Multichannel messaging across SMS, WhatsApp, and voice.

Use MessageBird when you need a single platform across SMS, WhatsApp, and voice channels.

FAQs

Specific to using Clearstream API API through Jentic.

Why is there no official OpenAPI spec for Clearstream API?

Clearstream does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Clearstream API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Clearstream API use?

Clearstream uses API key authentication. The key is passed in the X-Api-Key header on every request. When called via Jentic, the key is stored encrypted in the Jentic vault and never enters the agent's context window.

Can I schedule an SMS broadcast with the Clearstream API?

Yes. POST /messages accepts a list ID, a message body, and a send time. The platform queues the broadcast and delivers it at the scheduled moment. Use GET /messages to retrieve the resulting message records.

How do I send a one-off text message versus a broadcast?

POST /texts sends a single SMS to one recipient and is intended for replies and ad-hoc messages. POST /messages schedules a broadcast to a list and is intended for campaigns. Both produce records that can be read back via the corresponding GET endpoints.

What are the rate limits for the Clearstream API?

The OpenAPI spec does not declare rate limits explicitly. Practical throughput is governed by your Clearstream plan and SMS carrier delivery rates. For high-volume sends, schedule broadcasts via POST /messages so the platform handles delivery queuing.

How do I send an SMS broadcast through Jentic?

Search Jentic for 'send SMS to a subscriber list' and Jentic returns the POST /messages operation with its input schema. Run pip install jentic, then await client.search, await client.load, await client.execute to schedule the broadcast.