Clearstream API

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

★ Only Publicly Available OpenAPI DocumentCommunicationsSms MessagingapiKey48 EndpointsREST

For Agents

Manage SMS and MMS subscribers, lists, tags, keywords, workflows, media, and account statistics on the Clearstream messaging platform via 48 endpoints.

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.

Manage subscribers individually or in batches and segment them by tag

Maintain lists and add or remove subscribers from list memberships

Send and schedule SMS or MMS broadcasts to lists

Configure inbound keywords that trigger automated SMS responses

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 a church text messaging platform that lets organisations communicate with their communities via SMS and MMS. This expanded API surface covers subscriber and list management, tag-based segmentation, keyword automation, multi-step workflows, MMS media uploads, message and thread access, and account-level statistics. Authentication is by API key sent in the X-Api-Key header.

Use Cases

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

★ Tag-Based SMS Segmentation

Segment subscribers using tags so that broadcasts can target a specific subset of the audience without maintaining duplicate lists. Tags are first-class resources with bulk apply endpoints, so an agent can apply a tag to many subscribers at once and then send a broadcast targeted at that tag. Useful for event reminders, age-group ministries, or volunteer cohorts.

Call POST /tags/{id}/subscribers with the list of subscriber numbers to apply a tag, then send a broadcast targeted at that tag via POST /messages.

Keyword-Driven Inbound Automation

Configure inbound keywords so that subscribers texting a defined word in trigger an automatic SMS response, opt them into a list, or kick off a workflow. The keywords endpoint manages the catalog of active keywords and the workflows endpoint runs the multi-step automation behind them. This supports event signup flows, prayer request capture, and giving prompts.

Call POST /keywords with the keyword text and trigger configuration, then verify it via GET /keywords/{id}.

MMS Media Broadcast

Send picture messages by first uploading the image to Clearstream's media endpoint and then referencing the resulting media ID in a message broadcast. This works for event posters, sermon graphics, or daily encouragement images. Media assets persist on the account so the same image can be reused across multiple sends.

Upload an image via the media endpoint, then call POST /messages with the returned media ID and the target list to broadcast the picture message.

Bulk Subscriber Import from a CRM

Import or update large numbers of subscribers at once using the batch subscriber endpoint, avoiding rate-limit problems associated with one-at-a-time creation. Existing subscribers are upserted and new ones created in a single call. This makes it practical to keep Clearstream subscribers in sync with a church management system or CRM.

Call POST /subscribers/batch with an array of subscriber records exported from the CRM to upsert all of them in one request.

AI Agent SMS Engagement Pipeline

Allow an AI agent to run end-to-end SMS engagement: pull statistics, segment by tag, schedule a broadcast, and read back inbound threads, all through Jentic. The agent searches Jentic by intent and Clearstream credentials stay in the Jentic vault throughout the pipeline.

Search Jentic for 'segment subscribers by tag and send broadcast', then chain the tag-apply, message-create, and statistics operations to send and report on the broadcast.

Key Endpoints

48 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 or MMS

POST

/subscribers/batch

Bulk create or update subscribers

POST

/lists

Create a new list

POST

/lists/{id}/subscribers

Add a subscriber to a list

POST

/tags

Create a segmentation tag

POST

/tags/{id}/subscribers

Apply a tag to subscribers in bulk

POST

/keywords

Create an inbound keyword automation

GET

/account/headers

List recently used message headers

POST

/messages

Send or schedule a broadcast SMS or MMS

POST

/subscribers/batch

Bulk create or update subscribers

POST

/lists

Create a new list

POST

/lists/{id}/subscribers

Add a subscriber to a list

POST

/tags

Create a segmentation tag

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 call subscriber, message, and tag operations via Jentic's scoped access — the X-Api-Key value never enters the agent's prompt context.

Intent-based discovery

Agents search Jentic for intents like 'send MMS broadcast' or 'apply a tag to subscribers' and receive the exact Clearstream operation with its input schema, ready to execute.

Time to first call

Direct Clearstream integration across the full surface: 3-5 days for auth, lists, tags, keywords, workflows, and media handling. Through Jentic: under an hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Twilio API

General-purpose SMS and MMS platform with global carrier reach.

Choose Twilio when you need raw programmable messaging without church-specific list features.

Alternative

Clickatell Platform API

SMS and WhatsApp messaging through a unified platform.

Use Clickatell when WhatsApp delivery is required alongside SMS.

Alternative

Plivo API

Developer-focused SMS and voice platform with low per-message pricing.

Pick Plivo when cost-per-message and direct carrier connectivity matter most.

Alternative

Sinch API

Carrier-grade messaging across SMS, MMS, and rich messaging formats.

Use Sinch for high-volume international SMS and MMS with strong carrier relationships.

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 via the X-Api-Key header. The key is generated in the Clearstream account settings. Through Jentic, the key is stored encrypted in the Jentic vault and is never visible to the agent's prompt context.

Can I send MMS picture messages with the Clearstream API?

Yes. Upload the image through the media endpoint to obtain a media ID, then reference that ID in POST /messages alongside the target list. Clearstream delivers the image as an MMS to subscribers on supported carriers.

How do I bulk import subscribers from another system?

Use POST /subscribers/batch with an array of subscriber records. The endpoint upserts existing subscribers by phone number and creates new ones in the same call, which avoids hitting rate limits when syncing thousands of records.

What are the rate limits for the Clearstream API?

Rate limits are not declared in the public OpenAPI spec. For large operations such as subscriber sync use POST /subscribers/batch and POST /tags/{id}/subscribers rather than per-record calls so the server handles batching efficiently.

How do I segment and send through Jentic?

Search Jentic for 'apply a tag to subscribers and send broadcast'. Jentic returns the POST /tags/{id}/subscribers and POST /messages operations with their input schemas. Run pip install jentic, then await client.search, await client.load, await client.execute to chain the operations.