WayloAIWaylo Docs
APIReferenceAgents

Get agent

GET
/agents/{id}

One agent, by id.

Access: workspace_viewer · API key agents:read

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
id*string
workspaceId*string
name*string
greeting*string
systemPrompt*string
language*string
sttProvider*string
sttModel*string
sttOptions*
llmProvider*string
llmModel*string
llmOptions*
ttsProvider*string
ttsModel*string
ttsVoiceId*string
ttsOptions*
runtimeConfig*
catalogId*string|null
catalog*
presetId*string|null
toolFeedbackOverrides*
spokenReply*boolean
spokenReplyPrompt*string|null
documents*array<>
tools*array<>
destinations*array<>
version*number
active*boolean
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/agents/string' \  -H 'Authorization: Bearer sk_waylo_...'
Example Response
{  "id": "string",  "workspaceId": "string",  "name": "string",  "greeting": "string",  "systemPrompt": "string",  "language": "string",  "sttProvider": "string",  "sttModel": "string",  "sttOptions": {    "property1": "string",    "property2": "string"  },  "llmProvider": "string",  "llmModel": "string",  "llmOptions": {    "property1": "string",    "property2": "string"  },  "ttsProvider": "string",  "ttsModel": "string",  "ttsVoiceId": "string",  "ttsOptions": {    "property1": "string",    "property2": "string"  },  "runtimeConfig": {    "endpointing": {      "mode": "fixed",      "minDelayMs": 300,      "maxDelayMs": 1000,      "alpha": 0.9    },    "vad": {      "activationThreshold": 0.5,      "minSpeechDurationMs": 50,      "minSilenceDurationMs": 550    },    "backgroundAudio": {      "sound": "off",      "volume": 0.1,      "delaySeconds": 0    },    "thinkingSound": {      "enabled": false,      "delaySeconds": 1.5,      "volume": 0.3    },    "silenceTimeoutMs": 15000,    "silenceRetryAttempts": 3  },  "catalogId": "string",  "catalog": {    "id": "string",    "name": "string",    "description": "string",    "active": true  },  "presetId": "string",  "toolFeedbackOverrides": {    "property1": {      "ack": [        "string"      ],      "filler": [        "string"      ]    },    "property2": {      "ack": [        "string"      ],      "filler": [        "string"      ]    }  },  "spokenReply": true,  "spokenReplyPrompt": "string",  "documents": [    {      "id": "string",      "name": "string"    }  ],  "tools": [    {      "id": "string",      "name": "string",      "type": "api_request"    }  ],  "destinations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string"    }  ],  "version": 0,  "active": true,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Discard agent draft DELETE

Delete the unpublished configuration. Discarding when there is none succeeds. **Access:** workspace_admin · API key `agents:write`

Get agent draft GET

The unpublished configuration, as last saved. Unvalidated: a draft may be half-finished. **Access:** workspace_admin · API key `agents:read`