Official vendor OpenAPI document · agent-readyCommunicationsSms MessagingapiKey5 EndpointsREST
For Agents
Send, list, retrieve, update, and delete SMS messages across Twilio, MessageBird, Vonage, and Plivo through one unified API.
Use for: Send a one-time verification code via SMS, Send an order confirmation SMS to a customer, List all SMS messages sent in the last 24 hours, Look up whether an SMS was delivered or failed
Not supported: Does not handle voice calls, MMS, WhatsApp messaging, or inbound webhook delivery - use for outbound SMS message lifecycle operations only.
The Apideck SMS API is a focused unified interface for sending and managing SMS messages across providers including Twilio, MessageBird, Vonage, and Plivo. Five endpoints cover the full message lifecycle - list, create, get, update, and delete - so a SaaS product can hand SMS sending to whichever provider the customer has connected without writing per-vendor code. Authentication uses the standard Apideck Authorization header alongside x-apideck-app-id and x-apideck-consumer-id. Designed for transactional messaging, OTPs, and notifications rather than for bulk marketing campaigns.
Install Jentic One Beta
Connect the SMS API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the SMS 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%2Fapideck.com%2Fsms" | 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%2Fapideck.com%2Fsms" | 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 SMS API.
Send an SMS to a phone number with body and optional sender ID via POST /sms/messages
List sent and received messages with cursor pagination through GET /sms/messages
Look up the delivery status of a specific message by ID
Update a queued message's body or scheduled-send time before it is dispatched
Delete or cancel a queued message that has not yet been sent
Switch between Twilio, MessageBird, Vonage, or Plivo without changing client code
Use Cases
Patterns agents use SMS API for, with concrete tasks.
★ Cross-Provider Transactional SMS
Send transactional SMS - verification codes, order confirmations, appointment reminders - through whichever provider the customer has connected (Twilio, MessageBird, Vonage, Plivo) without writing per-vendor code. POST /sms/messages takes a phone number and body and returns the resulting message ID; GET /sms/messages/{id} reports delivery status. Useful for SaaS products that want to delegate provider choice to their customers.
Send an SMS to '+15551234567' with body 'Your verification code is 482910' and return the message_id and initial status
OTP and Verification Flows
Build a one-time-password flow on top of the Apideck SMS API. POST /sms/messages with the OTP body, then poll GET /sms/messages/{id} or rely on the customer's connected provider's webhook to confirm delivery. The same code path works whether the customer's connection is Twilio, MessageBird, Vonage, or Plivo.
Generate a 6-digit code, POST /sms/messages with body 'Your code: <code>' to the user's phone, and return both the code and the message_id
Scheduled Reminder Cancellation
Manage queued SMS reminders. POST /sms/messages with a scheduled-send time creates a queued message; PATCH /sms/messages/{id} updates the body or time; DELETE /sms/messages/{id} cancels it before dispatch. Useful for appointment-booking products where the customer might reschedule and the reminder needs to update or be cancelled.
List queued messages for phone '+15551234567', and for each one with a scheduled_send_time before tomorrow PATCH the time to one hour later
AI Agent SMS Notification via Jentic
An AI agent fires off an SMS as part of a workflow - for example, alerting a customer that an order has shipped. Through Jentic, the agent searches 'send an sms', loads the POST /sms/messages operation, and executes it with the recipient and body. Jentic stores the Apideck Authorization, x-apideck-app-id, and x-apideck-consumer-id headers separately so the agent never holds raw credentials.
Through Jentic, search 'send an sms', load POST /sms/messages, and send a shipping confirmation SMS with the tracking link to the customer's phone number
Key Endpoints
5 endpoints — the apideck sms api is a focused unified interface for sending and managing sms messages across providers including twilio, messagebird, vonage, and plivo.
METHOD
PATH
DESCRIPTION
GET
/sms/messages
List SMS messages
POST
/sms/messages
Send an SMS message
GET
/sms/messages/{id}
Get an SMS message by ID
PATCH
/sms/messages/{id}
Update a queued SMS message
DELETE
/sms/messages/{id}
Delete or cancel a queued SMS message
GET
/sms/messages
List SMS messages
POST
/sms/messages
Send an SMS message
GET
/sms/messages/{id}
Get an SMS message by ID
PATCH
/sms/messages/{id}
Update a queued SMS message
DELETE
/sms/messages/{id}
Delete or cancel a queued SMS message
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.
S
SMS API
- Non-Ready (F)0/100
78
Foundational Compliance85
Developer Experience & Jentic Compatibility60
AI-Readiness & Agent Experience94
Agent Usability50
Security0
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
78
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
14%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
85
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: ASignals: 4
64%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
75%
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.
60
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: B-Signals: 4
70%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
71%
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).
0
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: FSignals: 1
0%
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 Apideck SMS API by hand means setting up its API key plus consumer and service headers, learning the unified message shape, and normalising across SMS providers yourself. Through Jentic you install once, import Apideck SMS from the API Directory, store the key once, and your agent calls it.
Permission scoping
The Apideck SMS API puts the message id in the URL path (/sms/messages/{id}), so a rule can pin your agent to one message: it can read and update that message and nothing else. You choose the operations it may call, so delete is not included unless you add it.
Credential isolation
Your Apideck API key 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 an outbound SMS' or 'check a message's status', and Jentic returns the matching Apideck SMS 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 SMS API through Jentic.
What authentication does the Apideck SMS API use?
An apiKey scheme on the `Authorization` header with your Apideck application key. Through Jentic this value plus `x-apideck-app-id` and `x-apideck-consumer-id` are stored encrypted in the vault and injected at execution; the agent only ever holds a scoped token.
Can I send an SMS through Twilio, MessageBird, and Vonage with the same call?
Yes. POST /sms/messages takes a normalised payload - to, from, body, scheduled_send_time - that Apideck routes to whichever provider the customer's connection points at. The provider-specific message ID is returned as the response so subsequent GET /sms/messages/{id} calls work the same way across all providers.
What are the rate limits for the Apideck SMS API?
The OpenAPI spec does not publish per-endpoint rate limits. Apideck applies plan-based limits at unify.apideck.com plus the underlying provider's per-account messaging limits (Twilio's MPS limits, MessageBird's throughput tiers, etc.). See https://developers.apideck.com for your plan's gateway quota.
How do I send an SMS through Jentic?
Install with `pip install jentic`, then run the search query 'send an sms'. Jentic returns POST /sms/messages - load its schema, supply to, from (or sender_id), and body, then execute. The message lands on whichever provider the consumer has connected.
Can I cancel an SMS after it has been queued?
Yes - DELETE /sms/messages/{id} cancels a queued message before it is dispatched, and PATCH /sms/messages/{id} can update the body or scheduled-send time. Once a message has been handed to the underlying provider for delivery, cancellation is no longer possible - the provider's webhook will report the final status.
Does the SMS API support inbound messages?
GET /sms/messages can list inbound messages stored at the provider, but inbound delivery itself happens via the provider's webhook to your application - Apideck does not relay the inbound webhook through this API. Configure inbound handling at the underlying provider (Twilio, MessageBird, etc.).
Can I limit what my agent is allowed to do with the Apideck SMS API?
Yes. Because you run Jentic One yourself, your own rules decide which of the SMS operations and which credentials the agent may use. You pick the exact endpoints it can call, so you can let it send with POST /sms/messages and check status with GET /sms/messages/{id} while leaving DELETE /sms/messages/{id} out unless you explicitly add it. Since the message id sits in the URL path, a rule can even pin the agent to a single message so it reads and updates that one message and nothing else.
GET STARTED