{ "components": { "schemas": { "AutoReloadBody": { "properties": { "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "pack_id": { "pattern": "^(P50|P100|P200|P500|P1000)$", "title": "Pack Id", "type": "string" }, "rail": { "pattern": "^(stripe_saved|usdc)$", "title": "Rail", "type": "string" }, "threshold_segments": { "default": 100, "maximum": 1000000.0, "minimum": 0.0, "title": "Threshold Segments", "type": "integer" } }, "required": [ "pack_id", "rail" ], "title": "AutoReloadBody", "type": "object" }, "AutoTopupBody": { "properties": { "amount_cents": { "exclusiveMinimum": 0.0, "maximum": 100000000.0, "title": "Amount Cents", "type": "integer" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "rail": { "pattern": "^(stripe_saved|usdc)$", "title": "Rail", "type": "string" }, "threshold_cents": { "maximum": 100000000.0, "minimum": 0.0, "title": "Threshold Cents", "type": "integer" } }, "required": [ "rail", "threshold_cents", "amount_cents" ], "title": "AutoTopupBody", "type": "object" }, "CheckoutRequest": { "properties": { "amount_cents": { "exclusiveMinimum": 0.0, "maximum": 100000000.0, "title": "Amount Cents", "type": "integer" } }, "required": [ "amount_cents" ], "title": "CheckoutRequest", "type": "object" }, "CompanyCampaignBody": { "properties": { "brand_payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Brand Payload" }, "brand_provider_id": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Brand Provider Id" }, "campaign_payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Campaign Payload" }, "campaign_provider_id": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Campaign Provider Id" }, "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Details" }, "mode": { "default": "record", "pattern": "^(record|create)$", "title": "Mode", "type": "string" }, "status": { "anyOf": [ { "pattern": "^(submitted|active|failed)$", "type": "string" }, { "type": "null" } ], "title": "Status" }, "use_case": { "pattern": "^(alerts|reminders|conversational|personal_assistant|marketing)$", "title": "Use Case", "type": "string" } }, "required": [ "use_case" ], "title": "CompanyCampaignBody", "type": "object" }, "CreateAccount": { "properties": { "accept_tos": { "default": false, "title": "Accept Tos", "type": "boolean" }, "email": { "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "tos_version": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Tos Version" } }, "required": [ "name", "email" ], "title": "CreateAccount", "type": "object" }, "CreateBrand": { "properties": { "ein": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Ein" }, "legal_name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Legal Name" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "ownership_mode": { "anyOf": [ { "pattern": "^(reseller|csp)$", "type": "string" }, { "type": "null" } ], "title": "Ownership Mode" }, "vertical": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Vertical" }, "website": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Website" } }, "required": [ "name" ], "title": "CreateBrand", "type": "object" }, "CreateCampaign": { "properties": { "brand_id": { "maxLength": 200, "minLength": 1, "title": "Brand Id", "type": "string" }, "description": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "ownership_mode": { "anyOf": [ { "pattern": "^(reseller|csp)$", "type": "string" }, { "type": "null" } ], "title": "Ownership Mode" }, "use_case": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Use Case" } }, "required": [ "brand_id", "name" ], "title": "CreateCampaign", "type": "object" }, "CreateKey": { "properties": { "scope": { "pattern": "^(send|read|admin-lite)$", "title": "Scope", "type": "string" } }, "required": [ "scope" ], "title": "CreateKey", "type": "object" }, "CredentialsBody": { "properties": { "password": { "maxLength": 300, "minLength": 1, "title": "Password", "type": "string" }, "username": { "maxLength": 100, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "CredentialsBody", "type": "object" }, "Credit": { "properties": { "amount_cents": { "exclusiveMinimum": 0.0, "maximum": 100000000.0, "title": "Amount Cents", "type": "integer" }, "idempotency_key": { "maxLength": 200, "minLength": 1, "title": "Idempotency Key", "type": "string" }, "reason": { "default": "manual_credit", "maxLength": 200, "title": "Reason", "type": "string" } }, "required": [ "amount_cents", "idempotency_key" ], "title": "Credit", "type": "object" }, "CspTransition": { "properties": { "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "status": { "maxLength": 40, "minLength": 1, "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "CspTransition", "type": "object" }, "DeviceApproveBody": { "properties": { "password": { "maxLength": 300, "minLength": 1, "title": "Password", "type": "string" }, "user_code": { "maxLength": 20, "minLength": 4, "title": "User Code", "type": "string" }, "username": { "maxLength": 100, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "user_code", "username", "password" ], "title": "DeviceApproveBody", "type": "object" }, "DeviceCodeBody": { "properties": { "scope": { "default": "admin-lite", "pattern": "^(send|read|admin-lite)$", "title": "Scope", "type": "string" } }, "title": "DeviceCodeBody", "type": "object" }, "DeviceTokenBody": { "properties": { "device_code": { "maxLength": 200, "minLength": 8, "title": "Device Code", "type": "string" } }, "required": [ "device_code" ], "title": "DeviceTokenBody", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "InstantConnect": { "description": "Agent self-serve connect: the agent creates its own account.\nNo email, no human. Name is an agent-chosen label.", "properties": { "accept_tos": { "default": false, "title": "Accept Tos", "type": "boolean" }, "email": { "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Name" }, "tier": { "anyOf": [ { "pattern": "^(T1|T2|T3|T4|T5)$", "type": "string" }, { "type": "null" } ], "title": "Tier" }, "tos_version": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Tos Version" }, "use_case": { "pattern": "^(alerts|reminders|conversational|personal_assistant|marketing)$", "title": "Use Case", "type": "string" }, "wallet_address": { "anyOf": [ { "pattern": "^0x[0-9a-fA-F]{40}$", "type": "string" }, { "type": "null" } ], "title": "Wallet Address" }, "zip_code": { "anyOf": [ { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, { "type": "null" } ], "title": "Zip Code" } }, "required": [ "use_case" ], "title": "InstantConnect", "type": "object" }, "InstantSignupAdmin": { "description": "Operator-created InstantStart account (same core flow).", "properties": { "accept_tos": { "default": false, "title": "Accept Tos", "type": "boolean" }, "email": { "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "tier": { "anyOf": [ { "pattern": "^(T1|T2|T3|T4|T5)$", "type": "string" }, { "type": "null" } ], "title": "Tier" }, "tos_version": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Tos Version" }, "use_case": { "pattern": "^(alerts|reminders|conversational|personal_assistant|marketing)$", "title": "Use Case", "type": "string" }, "wallet_address": { "anyOf": [ { "pattern": "^0x[0-9a-fA-F]{40}$", "type": "string" }, { "type": "null" } ], "title": "Wallet Address" }, "zip_code": { "anyOf": [ { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, { "type": "null" } ], "title": "Zip Code" } }, "required": [ "name", "use_case" ], "title": "InstantSignupAdmin", "type": "object" }, "LoginBody": { "properties": { "password": { "maxLength": 300, "minLength": 1, "title": "Password", "type": "string" }, "scope": { "default": "admin-lite", "pattern": "^(send|read|admin-lite)$", "title": "Scope", "type": "string" }, "username": { "maxLength": 100, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "LoginBody", "type": "object" }, "MigrationCreate": { "properties": { "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "to_cnp": { "maxLength": 100, "minLength": 1, "title": "To Cnp", "type": "string" } }, "required": [ "to_cnp" ], "title": "MigrationCreate", "type": "object" }, "MigrationTransition": { "properties": { "note": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Note" }, "status": { "maxLength": 40, "minLength": 1, "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "MigrationTransition", "type": "object" }, "OtpSubmit": { "properties": { "pin": { "pattern": "^\\d{4,10}$", "title": "Pin", "type": "string" } }, "required": [ "pin" ], "title": "OtpSubmit", "type": "object" }, "PackPurchaseBody": { "properties": { "pack_id": { "pattern": "^(P50|P100|P200|P500|P1000)$", "title": "Pack Id", "type": "string" }, "rail": { "default": "stripe", "pattern": "^(stripe|stripe_saved|usdc)$", "title": "Rail", "type": "string" } }, "required": [ "pack_id" ], "title": "PackPurchaseBody", "type": "object" }, "PackRefundBody": { "properties": { "rail": { "default": "auto", "pattern": "^(auto|stripe|usdc)$", "title": "Rail", "type": "string" } }, "title": "PackRefundBody", "type": "object" }, "PaymentRequestBody": { "properties": { "amount_cents": { "exclusiveMinimum": 0.0, "maximum": 100000000.0, "title": "Amount Cents", "type": "integer" }, "kind": { "default": "topup", "pattern": "^(topup|plan)$", "title": "Kind", "type": "string" }, "save_payment_method": { "default": false, "title": "Save Payment Method", "type": "boolean" } }, "required": [ "amount_cents" ], "title": "PaymentRequestBody", "type": "object" }, "PlanBody": { "properties": { "tier": { "pattern": "^(T1|T2|T3|T4|T5)$", "title": "Tier", "type": "string" } }, "required": [ "tier" ], "title": "PlanBody", "type": "object" }, "PreviewMessage": { "properties": { "text": { "maxLength": 1600, "minLength": 1, "title": "Text", "type": "string" } }, "required": [ "text" ], "title": "PreviewMessage", "type": "object" }, "RefundBody": { "additionalProperties": true, "properties": { "amount_cents": { "exclusiveMinimum": 0.0, "maximum": 100000000.0, "title": "Amount Cents", "type": "integer" }, "idempotency_key": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "rail": { "default": "auto", "pattern": "^(auto|stripe|usdc)$", "title": "Rail", "type": "string" } }, "required": [ "amount_cents" ], "title": "RefundBody", "type": "object" }, "SeedNumber": { "properties": { "campaign_ref": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Campaign Ref" }, "number": { "maxLength": 32, "minLength": 5, "title": "Number", "type": "string" }, "pool_kind": { "default": "general", "pattern": "^(general|instant)$", "title": "Pool Kind", "type": "string" }, "use_case": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Use Case" } }, "required": [ "number" ], "title": "SeedNumber", "type": "object" }, "SendMessage": { "properties": { "from_number": { "maxLength": 32, "minLength": 5, "title": "From Number", "type": "string" }, "idempotency_key": { "maxLength": 200, "minLength": 1, "title": "Idempotency Key", "type": "string" }, "optimize": { "default": false, "title": "Optimize", "type": "boolean" }, "text": { "maxLength": 1600, "minLength": 1, "title": "Text", "type": "string" }, "to": { "maxLength": 32, "minLength": 5, "title": "To", "type": "string" } }, "required": [ "from_number", "to", "text", "idempotency_key" ], "title": "SendMessage", "type": "object" }, "SpendCapBody": { "properties": { "monthly_spend_cap_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Monthly Spend Cap Cents" } }, "title": "SpendCapBody", "type": "object" }, "SupportChat": { "properties": { "account_id": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Account Id" }, "conversation_id": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Conversation Id" }, "message": { "maxLength": 4000, "minLength": 1, "title": "Message", "type": "string" } }, "required": [ "message" ], "title": "SupportChat", "type": "object" }, "UpdateAccountSettings": { "properties": { "daily_cap_override": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Daily Cap Override" }, "notify_email": { "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "title": "Notify Email" }, "notify_webhook_secret": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Notify Webhook Secret" }, "notify_webhook_url": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Notify Webhook Url" }, "quarantined": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Quarantined" }, "quiet_hours_override": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Quiet Hours Override" } }, "title": "UpdateAccountSettings", "type": "object" }, "UpgradeRequest": { "properties": { "intake": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Intake" } }, "title": "UpgradeRequest", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "WalletBody": { "properties": { "wallet_address": { "pattern": "^0x[0-9a-fA-F]{40}$", "title": "Wallet Address", "type": "string" } }, "required": [ "wallet_address" ], "title": "WalletBody", "type": "object" }, "WalletCompleteBody": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Address" } }, "title": "WalletCompleteBody", "type": "object" }, "WalletRegisterBody": { "additionalProperties": true, "properties": { "address": { "maxLength": 100, "minLength": 1, "title": "Address", "type": "string" }, "make_primary": { "default": false, "title": "Make Primary", "type": "boolean" }, "method": { "default": "external", "pattern": "^(smart_wallet|agent_generated|external)$", "title": "Method", "type": "string" } }, "required": [ "address" ], "title": "WalletRegisterBody", "type": "object" }, "X402Send": { "properties": { "text": { "maxLength": 1600, "minLength": 1, "title": "Text", "type": "string" }, "to": { "maxLength": 32, "minLength": 5, "title": "To", "type": "string" } }, "required": [ "to", "text" ], "title": "X402Send", "type": "object" } } }, "info": { "description": "TextForAgents \u2014 SMS for AI agents. Prepaid, API-key authenticated texting with compliance (10DLC, opt-out, quiet hours) built in.", "title": "TextForAgents API", "version": "0.3.0" }, "openapi": "3.1.0", "paths": { "/admin/10dlc/campaigns/{campaign_id}/migrations": { "post": { "operationId": "admin_start_migration_admin_10dlc_campaigns__campaign_id__migrations_post", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "title": "Campaign Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Start Migration" } }, "/admin/accounts": { "get": { "operationId": "admin_list_accounts_admin_accounts_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin List Accounts" } }, "/admin/accounts/{account_id}": { "patch": { "operationId": "admin_update_account_admin_accounts__account_id__patch", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountSettings" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Update Account" } }, "/admin/accounts/{account_id}/close": { "post": { "description": "Churn path: close the account (terminal for sending) and\nquarantine every number it holds. Idempotent.", "operationId": "admin_close_account_admin_accounts__account_id__close_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Close Account" } }, "/admin/accounts/{account_id}/help-events": { "get": { "operationId": "admin_account_help_events_admin_accounts__account_id__help_events_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Account Help Events" } }, "/admin/accounts/{account_id}/refunds": { "post": { "description": "The AI support desk's refund tool (admin-authenticated):\nsame engine, same caps, same source-rail rule; the refund\nis recorded as support-requested and audit-logged.", "operationId": "create_refund_admin_admin_accounts__account_id__refunds_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Refund Admin" } }, "/admin/accounts/{account_id}/suppressions": { "get": { "operationId": "admin_account_suppressions_admin_accounts__account_id__suppressions_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Account Suppressions" } }, "/admin/accounts/{account_id}/ten-dlc": { "get": { "operationId": "admin_account_ten_dlc_admin_accounts__account_id__ten_dlc_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Account Ten Dlc" } }, "/admin/audit-log": { "get": { "description": "Read-only view of the append-only connection audit log.", "operationId": "admin_audit_log_admin_audit_log_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Audit Log" } }, "/admin/carrier": { "get": { "operationId": "admin_carrier_admin_carrier_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Carrier" } }, "/admin/csp": { "get": { "operationId": "admin_csp_admin_csp_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Csp" } }, "/admin/csp/migrations": { "get": { "operationId": "admin_list_migrations_admin_csp_migrations_get", "parameters": [ { "in": "query", "name": "campaign_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin List Migrations" } }, "/admin/csp/migrations/{migration_id}/transition": { "post": { "operationId": "admin_migration_transition_admin_csp_migrations__migration_id__transition_post", "parameters": [ { "in": "path", "name": "migration_id", "required": true, "schema": { "title": "Migration Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationTransition" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Migration Transition" } }, "/admin/csp/transition": { "post": { "operationId": "admin_csp_transition_admin_csp_transition_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CspTransition" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Csp Transition" } }, "/admin/delivery-receipts": { "get": { "operationId": "admin_delivery_receipts_admin_delivery_receipts_get", "parameters": [ { "in": "query", "name": "transport", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Delivery Receipts" } }, "/admin/deposits": { "get": { "operationId": "admin_deposits_admin_deposits_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Deposits" } }, "/admin/escalations": { "get": { "operationId": "admin_escalations_admin_escalations_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Escalations" } }, "/admin/instant": { "get": { "operationId": "admin_instant_admin_instant_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Instant" } }, "/admin/instant/company-campaigns": { "post": { "description": "Record an externally filed company campaign, or file one\nnow through the registration client (brand + campaign).", "operationId": "admin_company_campaign_admin_instant_company_campaigns_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCampaignBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Company Campaign" } }, "/admin/instant/company-campaigns/{use_case}/refresh": { "post": { "operationId": "admin_company_campaign_refresh_admin_instant_company_campaigns__use_case__refresh_post", "parameters": [ { "in": "path", "name": "use_case", "required": true, "schema": { "title": "Use Case", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Company Campaign Refresh" } }, "/admin/instant/refill": { "post": { "operationId": "admin_instant_refill_admin_instant_refill_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Instant Refill" } }, "/admin/instant/run": { "post": { "description": "One full maintenance pass (the cron runner's job, on\ndemand): queue expiry, upgrade pipelines, pool refill,\npromotions, auto-top-up evaluation.", "operationId": "admin_instant_run_admin_instant_run_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Instant Run" } }, "/admin/numbers": { "get": { "operationId": "admin_numbers_admin_numbers_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Numbers" }, "post": { "description": "Load a number into the pool as available inventory.\nPhase 9: pool_kind='instant' stocks pre-warmed InstantStart\nnumbers for one use-case template, pre-attached to a\ncompany campaign (campaign_ref).", "operationId": "admin_seed_number_admin_numbers_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedNumber" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Seed Number" } }, "/admin/ports": { "get": { "operationId": "admin_ports_admin_ports_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Ports" } }, "/admin/ports/run": { "post": { "description": "One global port-lifecycle pass (the cron runner's job,\non demand).", "operationId": "admin_ports_run_admin_ports_run_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Ports Run" } }, "/admin/support/tickets/{ticket_id}": { "get": { "operationId": "admin_support_ticket_admin_support_tickets__ticket_id__get", "parameters": [ { "in": "path", "name": "ticket_id", "required": true, "schema": { "title": "Ticket Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Support Ticket" } }, "/admin/suppressions": { "get": { "operationId": "admin_all_suppressions_admin_suppressions_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin All Suppressions" } }, "/admin/x402/refunds-owed": { "get": { "operationId": "admin_x402_refunds_admin_x402_refunds_owed_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin X402 Refunds" } }, "/auth/device/approve": { "post": { "description": "The human side of the device flow: type the user code\nand log in with username/password. Approving binds the code\nto the account \u2014 the password itself never reaches the\nagent.", "operationId": "auth_device_approve_auth_device_approve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceApproveBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Auth Device Approve" } }, "/auth/device/code": { "post": { "description": "Start the device-code flow: the agent shows its human\nthe user_code + verification path; the human approves by\nlogging in there. The agent then polls /auth/device/token.", "operationId": "auth_device_code_auth_device_code_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCodeBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Auth Device Code" } }, "/auth/device/token": { "post": { "operationId": "auth_device_token_auth_device_token_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceTokenBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Auth Device Token" } }, "/auth/login": { "post": { "operationId": "auth_login_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Auth Login" } }, "/health": { "get": { "operationId": "health_health_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Health" } }, "/legal": { "get": { "operationId": "legal_versions_legal_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Legal Versions" } }, "/support/chat": { "post": { "operationId": "support_chat_support_chat_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportChat" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Support Chat" } }, "/v1/accounts": { "post": { "operationId": "create_account_v1_accounts_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Account" } }, "/v1/accounts/connect": { "post": { "description": "The zero-touch entry point: an agent creates its own\naccount when it installs/connects the tool. No email, no\nhuman, no approval \u2014 identity is the returned API key.", "operationId": "agent_connect_v1_accounts_connect_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstantConnect" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Agent Connect" } }, "/v1/accounts/instant": { "post": { "operationId": "admin_instant_signup_v1_accounts_instant_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstantSignupAdmin" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Admin Instant Signup" } }, "/v1/accounts/{account_id}/10dlc": { "get": { "operationId": "get_ten_dlc_v1_accounts__account_id__10dlc_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Ten Dlc" } }, "/v1/accounts/{account_id}/10dlc/brands": { "post": { "operationId": "create_brand_v1_accounts__account_id__10dlc_brands_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBrand" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Brand" } }, "/v1/accounts/{account_id}/10dlc/brands/{brand_id}": { "get": { "operationId": "get_brand_v1_accounts__account_id__10dlc_brands__brand_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "brand_id", "required": true, "schema": { "title": "Brand Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Brand" } }, "/v1/accounts/{account_id}/10dlc/brands/{brand_id}/submit": { "post": { "operationId": "submit_brand_v1_accounts__account_id__10dlc_brands__brand_id__submit_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "brand_id", "required": true, "schema": { "title": "Brand Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit Brand" } }, "/v1/accounts/{account_id}/10dlc/campaigns": { "post": { "operationId": "create_campaign_v1_accounts__account_id__10dlc_campaigns_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaign" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Campaign" } }, "/v1/accounts/{account_id}/10dlc/campaigns/{campaign_id}": { "get": { "operationId": "get_campaign_v1_accounts__account_id__10dlc_campaigns__campaign_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "campaign_id", "required": true, "schema": { "title": "Campaign Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Campaign" } }, "/v1/accounts/{account_id}/10dlc/campaigns/{campaign_id}/submit": { "post": { "operationId": "submit_campaign_v1_accounts__account_id__10dlc_campaigns__campaign_id__submit_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "campaign_id", "required": true, "schema": { "title": "Campaign Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit Campaign" } }, "/v1/accounts/{account_id}/auto-topup": { "delete": { "operationId": "delete_auto_topup_v1_accounts__account_id__auto_topup_delete", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Auto Topup" }, "get": { "operationId": "get_auto_topup_v1_accounts__account_id__auto_topup_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Auto Topup" }, "put": { "operationId": "set_auto_topup_v1_accounts__account_id__auto_topup_put", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopupBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Auto Topup" } }, "/v1/accounts/{account_id}/balance": { "get": { "operationId": "get_balance_v1_accounts__account_id__balance_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Balance" } }, "/v1/accounts/{account_id}/billing": { "get": { "description": "Plan, catalogs, pack balance, spend cap, auto-reload rule\nand recent pack purchases \u2014 the whole billing picture in one\nread.", "operationId": "get_billing_v1_accounts__account_id__billing_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Billing" } }, "/v1/accounts/{account_id}/billing/auto-reload": { "delete": { "operationId": "delete_auto_reload_v1_accounts__account_id__billing_auto_reload_delete", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Auto Reload" }, "get": { "operationId": "get_auto_reload_v1_accounts__account_id__billing_auto_reload_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Auto Reload" }, "put": { "description": "The overage subscription: when the pack balance drops\nbelow the threshold, one purchase of the chosen pack fires\nper threshold crossing.", "operationId": "set_auto_reload_v1_accounts__account_id__billing_auto_reload_put", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoReloadBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Auto Reload" } }, "/v1/accounts/{account_id}/billing/packs/purchase": { "post": { "description": "Buy a reload pack. Rail 'stripe' returns a Checkout URL\nand credits NOTHING until the webhook confirms payment;\n'stripe_saved' charges the saved method now; 'usdc' converts\nexisting USD ledger balance now. Segment credit is\nexactly-once under replayed confirmations.", "operationId": "purchase_pack_v1_accounts__account_id__billing_packs_purchase_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackPurchaseBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Purchase Pack" } }, "/v1/accounts/{account_id}/billing/packs/{purchase_id}/refund": { "post": { "description": "Refund a pack purchase's UNUSED segments at pro-rata\nvalue through the Phase 9.1 refund engine \u2014 forced onto the\nrail the purchase was paid on (the source-rail rule), once\nper purchase, ever.", "operationId": "refund_pack_v1_accounts__account_id__billing_packs__purchase_id__refund_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "purchase_id", "required": true, "schema": { "title": "Purchase Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackRefundBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Refund Pack" } }, "/v1/accounts/{account_id}/billing/plan": { "put": { "description": "Assign/change the account's tier. This is the opt-in that\nswitches sends from per-segment USD to allowance/pack draws.", "operationId": "set_billing_plan_v1_accounts__account_id__billing_plan_put", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Billing Plan" } }, "/v1/accounts/{account_id}/billing/spend-cap": { "put": { "description": "The affordability guarantee: a hard monthly ceiling on\npack + auto-reload spend. null = no cap; 0 = no pack spend.", "operationId": "set_spend_cap_v1_accounts__account_id__billing_spend_cap_put", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpendCapBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Spend Cap" } }, "/v1/accounts/{account_id}/charges": { "get": { "description": "The account's charge list: every payment request and\nauto-top-up attempt, newest first. Phase 9.1 adds the\naccount's refunds alongside (same honest status vocabulary).", "operationId": "list_charges_v1_accounts__account_id__charges_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Charges" } }, "/v1/accounts/{account_id}/credentials": { "post": { "description": "Set/replace the account's username + password (an\noptional human convenience \u2014 never required). Setting\ncredentials revokes every existing session.", "operationId": "set_credentials_v1_accounts__account_id__credentials_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialsBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Credentials" } }, "/v1/accounts/{account_id}/credits": { "post": { "operationId": "add_credit_v1_accounts__account_id__credits_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credit" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Credit" } }, "/v1/accounts/{account_id}/funding": { "get": { "operationId": "get_funding_v1_accounts__account_id__funding_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "query", "name": "amount_cents", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Amount Cents" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Funding" } }, "/v1/accounts/{account_id}/instant": { "get": { "operationId": "get_instant_v1_accounts__account_id__instant_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Instant" } }, "/v1/accounts/{account_id}/instant/intake": { "post": { "description": "Agent-led registration intake (opt-in upgrade): the\nagent submits the owner's details it collected\nconversationally. Validation errors are per-field and\nagent-readable so the agent can ask follow-ups.", "operationId": "submit_intake_v1_accounts__account_id__instant_intake_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit Intake" } }, "/v1/accounts/{account_id}/instant/otp": { "post": { "description": "The owner reads the texted code to their agent; the\nagent submits it here. No form, no human UI.", "operationId": "submit_otp_v1_accounts__account_id__instant_otp_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpSubmit" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit Otp" } }, "/v1/accounts/{account_id}/instant/otp/request": { "post": { "operationId": "request_otp_v1_accounts__account_id__instant_otp_request_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Request Otp" } }, "/v1/accounts/{account_id}/instant/run": { "post": { "description": "Nudge this account's upgrade pipeline + flush (the cron\nrunner does the same globally; agents poll status, and this\nlets an interactive agent move its own filing along).", "operationId": "run_instant_account_v1_accounts__account_id__instant_run_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Run Instant Account" } }, "/v1/accounts/{account_id}/instant/upgrade": { "post": { "description": "Opt in to the dedicated brand/campaign upgrade. Accepts\nan intake inline, or uses the one already on file.", "operationId": "request_upgrade_v1_accounts__account_id__instant_upgrade_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Request Upgrade" } }, "/v1/accounts/{account_id}/keys": { "post": { "operationId": "create_key_v1_accounts__account_id__keys_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKey" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Key" } }, "/v1/accounts/{account_id}/numbers": { "get": { "operationId": "list_numbers_v1_accounts__account_id__numbers_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Numbers" }, "post": { "description": "Just-in-time assignment: take the oldest available pool\nnumber, or have the provisioning provider order one on\ndemand. An empty pool with no provider configured is an\nhonest 503 \u2014 numbers are never invented.", "operationId": "assign_number_v1_accounts__account_id__numbers_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Assign Number" } }, "/v1/accounts/{account_id}/numbers/{number}/port-out": { "post": { "description": "Port-out: the customer takes their number elsewhere.\nNever blocked \u2014 it is their number. The number stays\nassigned (and on the account's plan) until the provider\nconfirms the port completed.", "operationId": "request_port_out_v1_accounts__account_id__numbers__number__port_out_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Request Port Out" } }, "/v1/accounts/{account_id}/numbers/{number}/release": { "post": { "description": "Release an assigned number into quarantine (it cannot be\nreassigned, send, or receive until the quarantine expires\nand the sweep recycles it).", "operationId": "release_number_v1_accounts__account_id__numbers__number__release_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "number", "required": true, "schema": { "title": "Number", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Release Number" } }, "/v1/accounts/{account_id}/payment-requests": { "get": { "operationId": "list_payment_requests_v1_accounts__account_id__payment_requests_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Payment Requests" }, "post": { "description": "The agent creates a payment request; the human just taps\nthrough the returned Stripe Checkout URL (Apple Pay /\nGoogle Pay / card). Crediting happens in the webhook.", "operationId": "create_payment_request_v1_accounts__account_id__payment_requests_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Payment Request" } }, "/v1/accounts/{account_id}/payments/start": { "post": { "description": "Phase 9.1 payment entry point. With a wallet on file this\nis the normal payment request. With NO wallet it returns a\nwallet-creation step instead of failing: the payment is\nparked, a passkey smart wallet is minted (one device\nconfirmation by the human), and the payment resumes the\nmoment the address lands.", "operationId": "start_payment_v1_accounts__account_id__payments_start_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Start Payment" } }, "/v1/accounts/{account_id}/ports": { "get": { "operationId": "list_account_ports_v1_accounts__account_id__ports_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Account Ports" }, "post": { "description": "Port-in intake: a business keeps its existing number.\nPer-field errors are agent-readable so the agent can ask\nits owner precise follow-ups. The carrier PIN/password is\nNEVER accepted \u2014 only the boolean that the customer has\nit; secret-shaped payloads die at the guard, and fields\nnamed like the secret itself are rejected by validation.", "operationId": "request_port_in_v1_accounts__account_id__ports_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Request Port In" } }, "/v1/accounts/{account_id}/ports/run": { "post": { "description": "Advance this account's port lifecycles one step (the\ncron runner does the same globally). With no porting\nprovider configured, requests honestly stay PORT_REQUESTED\nwith detail port_provider_not_configured.", "operationId": "run_account_ports_v1_accounts__account_id__ports_run_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Run Account Ports" } }, "/v1/accounts/{account_id}/ports/{port_id}": { "get": { "operationId": "get_account_port_v1_accounts__account_id__ports__port_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "port_id", "required": true, "schema": { "title": "Port Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Account Port" } }, "/v1/accounts/{account_id}/ports/{port_id}/cancel": { "post": { "operationId": "cancel_account_port_v1_accounts__account_id__ports__port_id__cancel_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "port_id", "required": true, "schema": { "title": "Port Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Cancel Account Port" } }, "/v1/accounts/{account_id}/refunds": { "get": { "operationId": "list_refunds_v1_accounts__account_id__refunds_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Refunds" }, "post": { "description": "Issue a refund under the source-rail rule (see\napp/refunds.py): card-paid credit returns only to the\noriginal payment method via Stripe; USDC-funded credit\nreturns only in USDC to the registered wallet / original\nfunding address. Over-cap and exceptional USDC refunds\nescalate with a prepared summary \u2014 never silently fail.", "operationId": "create_refund_v1_accounts__account_id__refunds_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Refund" } }, "/v1/accounts/{account_id}/sessions": { "get": { "operationId": "list_sessions_v1_accounts__account_id__sessions_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Sessions" } }, "/v1/accounts/{account_id}/sessions/{session_id}/revoke": { "post": { "operationId": "revoke_session_v1_accounts__account_id__sessions__session_id__revoke_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Revoke Session" } }, "/v1/accounts/{account_id}/wallet": { "post": { "operationId": "set_wallet_v1_accounts__account_id__wallet_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Wallet" } }, "/v1/accounts/{account_id}/wallets": { "get": { "operationId": "list_wallets_v1_accounts__account_id__wallets_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Wallets" }, "post": { "description": "Register a PUBLIC address for the account (method\nexternal | agent_generated). Secret key material in ANY\nfield is refused by the guard \u2014 an agent-generated wallet's\nseed never transits this API. Registering a wallet also\ncompletes a pending mint-on-payment session, if one exists,\nand resumes its parked payment.", "operationId": "register_wallet_v1_accounts__account_id__wallets_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletRegisterBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Register Wallet" } }, "/v1/billing/checkout": { "post": { "operationId": "stripe_checkout_v1_billing_checkout_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Stripe Checkout" } }, "/v1/messages": { "get": { "operationId": "list_messages_v1_messages_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Messages" } }, "/v1/messages/preview": { "post": { "description": "Phase 8a: segment preview for a draft message \u2014 encoding,\nsegment count, and what optimize=true would send instead.\nRead-only: no message row, no ledger entry, no provider\ncall, so it is safe to call on every draft.", "operationId": "preview_message_v1_messages_preview_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewMessage" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Preview Message" } }, "/v1/messages/send": { "post": { "operationId": "send_message_v1_messages_send_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessage" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Send Message" } }, "/v1/wallet-creation/{session_id}": { "get": { "description": "Poll a mint-on-payment session. The session id is an\nunguessable capability (uuid4); the session can only ever\nregister a public address and resume a parked payment.", "operationId": "get_wallet_creation_v1_wallet_creation__session_id__get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Wallet Creation" } }, "/v1/wallet-creation/{session_id}/complete": { "post": { "description": "The smart-wallet creation callback: carries the new\nPUBLIC address (or none \u2014 the provider session is resolved\nserver-side). The address registers as a smart_wallet and\nthe parked payment resumes. Key material is refused by the\nguard before anything else happens.", "operationId": "complete_wallet_creation_v1_wallet_creation__session_id__complete_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletCompleteBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Complete Wallet Creation" } }, "/v1/x402/send": { "post": { "operationId": "x402_send_v1_x402_send_post", "parameters": [ { "in": "header", "name": "X-PAYMENT", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Payment" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/X402Send" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "X402 Send" } }, "/webhooks/smpp/dlr": { "post": { "description": "DLR callback from our SMPP gateway (Jasmin). Accepts a JSON\nbody, a form body, or query params (gateway-dependent):\nprovider id under provider_id|message_id|id, status under\nstatus|dlr_status|message_status|stat, bind name under\nbind|transport. When SMPP_DLR_SECRET is configured the gateway\nmust send it as the X-DLR-Secret header \u2014 an unauthenticated\ncaller must never be able to forge delivery state.", "operationId": "smpp_dlr_webhooks_smpp_dlr_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Smpp Dlr" } }, "/webhooks/stripe": { "post": { "operationId": "stripe_webhook_webhooks_stripe_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Stripe Webhook" } }, "/webhooks/telnyx": { "post": { "operationId": "telnyx_webhook_webhooks_telnyx_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Telnyx Webhook" } } }, "servers": [ { "url": "https://api.textforagents.com" } ] }