Community OpenAPI document · agent-readyCommunicationsSms MessagingapiKey18 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically sendflashmessage. Covers 18 operations with apiKey authentication.
Use for: I need to sendflashmessage, Find available communications operations, Get the current status of The SMS Works API resources, List all records from The SMS Works API
Not supported: Does not handle payments, crm, or developer tools - use for communications only.
The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed messages are refunded. The API exposes 18 endpoints secured with apiKey authentication.
Install Jentic One Beta
Connect the The SMS Works API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the The SMS Works 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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fthesmsworks.co.uk%2Fthe-sms-works-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fthesmsworks.co.uk%2Fthe-sms-works-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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 The SMS Works API.
sendFlashMessage
Manage communications data programmatically
Integrate The SMS Works API into automated workflows
Query and filter The SMS Works API records by parameters
Monitor The SMS Works API operational status and events
Use Cases
Patterns agents use The SMS Works API for, with concrete tasks.
★ Communications Operations
Use the The SMS Works API to perform communications operations programmatically. The API provides 18 endpoints covering core functionality including sendflashmessage.
Call POST /message/flash to sendflashmessage
Data Retrieval and Monitoring
Query The SMS Works API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.
Poll the primary The SMS Works API endpoint, compare response to last known state, and alert if changed
AI Agent Integration via Jentic
AI agents discover and call The SMS Works API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'sendflashmessage', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
18 endpoints — the sms works provides a low-cost, reliable sms api for developers.
METHOD
PATH
DESCRIPTION
POST
/message/flash
sendFlashMessage
POST
/message/flash
sendFlashMessage
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
T
The SMS Works API
- Non-Ready (F)39/100
64
Foundational Compliance71
Developer Experience & Jentic Compatibility16
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
64
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: BSignals: 4
95%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
71
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
43%
Example Density
How richly the API is illustrated with examples.
86%
Example Validity
Percentage of examples that conform to their schemas.
56%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
16
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
58%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
6%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring The SMS Works by hand means exchanging your credentials for a JWT, passing it in the Authorization header on each send, and handling your own retries. Through Jentic you install once, import The SMS Works from the API Directory, store the credential once, and your agent calls it.
Permission scoping
The SMS Works takes the recipient in the request body rather than an owned URL path, so scope it by operations: limit the agent to the operations it needs, such as sending a flash message, and leave out anything else. Every operation you credit it with stays inside that allowed set.
Credential isolation
Your The SMS Works credential 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 flash SMS', and Jentic returns the matching The SMS Works operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using The SMS Works API through Jentic.
What authentication does the The SMS Works API use?
The The SMS Works API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I sendflashmessage with the The SMS Works API?
Yes. Use the POST /message/flash endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the The SMS Works API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I sendflashmessage through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'sendflashmessage'. Jentic returns the matching The SMS Works API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the The SMS Works API have?
The The SMS Works API exposes 18 endpoints covering batch, batches, credits operations.
Can I limit what my agent is allowed to do with the The SMS Works API?
Yes. Because The SMS Works takes the recipient in the request body rather than an owned URL path, you scope the agent by operations in your self-hosted Jentic One instance, where your own rules decide which operations and credentials the agent may use. Grant it only the operations it needs, such as POST /message/flash to send a flash message, and leave out the rest of the 18 endpoints like credits, batches, and message queries. Every operation you credit the agent with stays inside that allowed set, and anything you do not grant it cannot call.
GET STARTED