Skip to main content
POST
Create a Shortext endpoint

Authorizations

Authorization
string
header
required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Body

application/json
name
string

Required on creation

Maximum string length: 255
agent_id
string | null

Agent answering on the endpoint; null detaches it

Example:

"AGI-XXXXX"

enabled
boolean
default:true
reply_mode
enum<string>
default:async

async: replies pushed to webhook_url (signed); sync: replies in the response of the inbound call

Available options:
async,
sync
sync_timeout
integer
default:25

Seconds the sync mode waits for the replies

Required range: 1 <= x <= 25
webhook_url
string | null

Where the replies are pushed (https); null removes it

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false