Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

FlowClient Credentials
Token URL
/api/v1/api-keys
Scopes1
sms:read
Read the org's SMS (10DLC) registration status and numbers, SMS contacts, and download any text-message attachment by id (getSMSMedia) — pictures, videos and files (such as a PDF) sent or received by text.

Path Parameters

id
string
required

The attachment id — from uploadSMSMedia, a send receipt's media, an sms.message.received event's media, or a transcript turn's attachments.

Response

The attachment's details and a short-lived download link.

success
boolean
required
data
object
required

An attachment's details and a short-lived download link (getSMSMedia).

message
string
errors
object[]