AgentsIdPublic
/Agents/{id}/public
Authorization
Bearer AuthorizationBearer <token>
JWT Authorization header using Bearer scheme
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
curl -X GET "https://test.api.speaknode.com/api/Agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/public"{
"public_agent": {
"publish_options": {
"language_dropdown": true,
"appearance": "Tiny",
"placement": "TopLeft",
"main_label": "string",
"button_label": "string",
"end_call_button_label": "string",
"show_transcript": true,
"theme": "Light",
"allow_variables_input": true
},
"languages": [
{
"language_locale_id": "96776dbf-250a-49f2-a14d-7e906d335ad0",
"language": "string",
"language_code": "string",
"locale": "string",
"locale_code": "string",
"full_code": "string",
"flag": "string",
"is_default": true
}
],
"agent_token": "string",
"agent_token_expires_at": "2019-08-24T14:15:22Z",
"variables_open_api_schema": {
"type": "string",
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [
{}
],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [
{}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [
{
"name": "string",
"descriptor": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"type": "string",
"title": "string",
"description": "string",
"format": "string",
"nullable": true,
"default": null,
"enum": [
null
],
"minimum": 0,
"maximum": 0,
"minLength": 0,
"maxLength": 0,
"pattern": "string",
"minItems": 0,
"maxItems": 0,
"items": {
"enum": [],
"properties": [],
"required": [],
"x-enumNames": []
},
"properties": [],
"required": [
null
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
null
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
},
"properties": [],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
],
"x-order": 0,
"x-fill-mode": "constant",
"x-enumNames": [
"string"
]
}
}
],
"required": [
"string"
]
}
}
}/Agents/{id}/dispatch POST
Previous Page
Takes a human conversation into the module. Audio, audio with a ready transcript, or a transcript alone — all three are supported; audio itself is uploaded beforehand through `/api/files/upload-url` with file type `ConversationAudio`, so the file never travels through this API. A transcript without timings is accepted, and the response says so: talk share, silence, interruptions and speech rate stay unmeasured rather than being reported as zero. POST
Next Page