30 available actions
What your AI agent can do in Saperly
Saperly is the phone carrier for AI agents — phone numbers, voice, SMS, and compliance in one API. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 30 actions.
Common starting points
- Check ConsentCheck whether a contact currently has active TCPA consent for one of your Saperly numbers, given numberId (your number) and peerNumber (the contact's E.164 number) as…
- Get CallFetch a single call by its id, returning its status, per-minute rate, final duration (durationSec) and cost (costCents), and the hasRecording / hasTranscript flags.
- Create ConnectionCreate a connection: the AI 'brain' that answers calls and (optionally) SMS on a Saperly phone number.
- Record ConsentRecord TCPA consent for a contact so outbound SMS (SAPERLY_SEND_SMS) and calls (SAPERLY_PLACE_CALL) from your number are permitted.
- Update ConnectionPartially update a connection (the AI answering brain bound to a number).
- Set Number Caller ID NameSet the outbound caller ID name / CNAM (1-15 characters: letters, digits, spaces) presented to recipients on outbound calls from a Saperly phone number, or pass…
Browse all 30 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 14 actions
- Check ConsentCheck whether a contact currently has active TCPA consent for one of your Saperly numbers, given numberId (your number) and peerNumber (the contact's E.164 number) as…
- Get CallFetch a single call by its id, returning its status, per-minute rate, final duration (durationSec) and cost (costCents), and the hasRecording / hasTranscript flags.
- Get Call RecordingGet the audio recording for a call and return it as a downloadable file.
- Get Call TranscriptFetch the transcript (conversation turns/segments) of a completed call by its id.
- Get ConnectionFetch a single connection (the AI answering brain / persona that handles calls and SMS) by its id, returning its full config: name, mode, backend, instructions, tts…
- Get Phone NumberFetch a single phone number by its id, returning its E.164 phoneNumber, bound connectionId, webhookUrl, country, numberType, pricing and lifecycle fields.
- Get Usage & BalanceReturn the workspace usage summary and prepaid balance: calls {count, totalCostCents, totalDurationSec}, messages {count}, and balanceCents (the prepaid balance, in…
- List CallsReturn the full voice-call history (inbound + outbound) for the connected Saperly workspace.
- List ConnectionsReturn every connection (the AI persona / answering 'brain' that handles calls and SMS) in the connected Saperly workspace.
- List Consent RecordsReturn every TCPA consent record in the connected Saperly workspace, with each record's id, numberId (the Saperly number contact is authorized FROM), peerNumber (the…
- List LanguagesReturn the spoken languages Saperly supports for voice connections, each as a {code, name} pair (about 42 entries, e.g.
- List MessagesReturn SMS messages in the connected Saperly workspace (both inbound and outbound).
- List Phone NumbersReturn every phone number provisioned in the connected Saperly workspace, with each number's id, phoneNumber (E.164), the connectionId (answering brain) bound to it…
- List VoicesList the text-to-speech voices available for Saperly connections.
Create & communicateCreate records or send supported messagesView 3 actions
- Create ConnectionCreate a connection: the AI 'brain' that answers calls and (optionally) SMS on a Saperly phone number.
- Record ConsentRecord TCPA consent for a contact so outbound SMS (SAPERLY_SEND_SMS) and calls (SAPERLY_PLACE_CALL) from your number are permitted.
- Send SMSPAID / METERED: send a single SMS from one of your Saperly numbers to an E.164 destination.
Update & manageChange and manage existing recordsView 4 actions
- Set Number Caller ID NameSet the outbound caller ID name / CNAM (1-15 characters: letters, digits, spaces) presented to recipients on outbound calls from a Saperly phone number, or pass…
- Set Number SMS Sender IDSet the alphanumeric SMS sender id (1-11 alphanumeric chars, e.g.
- Set Number WebhookSet the HTTPS webhook URL that Saperly POSTs this number's events (inbound SMS/calls, status) to.
- Update ConnectionPartially update a connection (the AI answering brain bound to a number).
Remove & cancelRemove records or cancel supported workView 1 action
- Delete ConnectionPERMANENTLY AND IRREVERSIBLY delete a connection (the AI answering brain / persona that handles calls and SMS) by its id.
Other actionsSpecialist and administrative actions.View 8 actions
- Bind Connection to NumberAttach a connection (the AI persona / answering brain from SAPERLY_CREATE_CONNECTION) to a phone number, so inbound calls and SMS to that number — and outbound calls…
- End CallEnd an in-progress call by its id, hanging up and settling the metered cost.
- Place CallPAID / METERED — places a REAL outbound voice call that RINGS A REAL PHONE and BILLS PER MINUTE (~26¢/min); it keeps billing until hung up — end it with…
- Provision Phone NumberPAID / METERED: provision (buy) a new phone number in a country.
- Quote Number PriceREAD-ONLY and FREE: quote the price to provision a phone number in a country/type, returning { customerMonthlyCents, customerUpfrontCents }.
- Release Phone NumberPERMANENTLY AND IRREVERSIBLY release a phone number back to the carrier.
- Revoke ConsentRevoke a contact's TCPA consent for a given Saperly number, blocking further outbound contact to them.
- Transfer CallPAID / METERED — BLIND-transfers a LIVE, in-progress voice call to another destination (an E.164 number like +15551230000, or a URI).
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Saperly
How does the agent connect to Saperly?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Saperly?
The page above lists the 30 actions currently available through the Saperly connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Saperly included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Saperly is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Saperly to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.