Skip to main content
POST
Chat with an agent (headless)

Authorizations

Authorization
string
header
required

A workspace API key: wdy_live_… / wdy_test_…. Created at POST /workspaces/{tenantId}/keys and shown exactly once.

Path Parameters

agentId
string
required

Body

application/json
message
string
required

The visitor question the agent answers.

Required string length: 1 - 1000
locale
enum<string>
default:es
Available options:
es,
en
conversationId
string

Continue a conversation: pass the conversationId a previous turn returned. Omit to start a new one; the server owns the transcript.

Response

conversationId
string
required

The server-owned conversation this turn is in.

reply
string
required

The assistant’s text answer.

components
object[]
required

The generative-UI components the agent chose to render.

cached
boolean
required

True when the turn was replayed from cache (spent no credit).