startAgentConversation
Start a new Ask Goliath chat as the key owner with its first message.
Start a new Ask Goliath chat as the key owner with its first message; it shows in their chat list as "via" this key's name. Returns the turn (getAgentTurn). Waits up to waitSeconds (0-25, default 25) for the reply; poll getAgentTurn after. confirmSends: an approval card for a text or email carries its draft; trust decides if it asks.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"operationId": "startAgentConversation",
"variables": {
"message": "<String>"
}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
const result = await goliath.askGoliath.startAgentConversation(
{
message: '<String>'
},
{ idempotencyKey: crypto.randomUUID() },
)const res = await fetch('https://server.goliathdata.com/api/v1/call', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
operationId: 'startAgentConversation',
variables: {
message: '<String>'
}
}),
})
const { data, errors } = await res.json()Variables
The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.
Default 25.
Default false.
Default false.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"externalAgentChatMutation": {
"startAgentConversation": {
"conversationId": "<ID>",
"turnId": "<ID>",
"runId": "<ID>",
"status": "RUNNING",
"reply": "…",
"questions": [
{
"id": "<ID>",
"prompt": "…",
"kind": "…",
"options": [
"…"
],
"multi": true,
"allowOther": true,
"approval": true,
"tone": "…",
"confirmLabel": "…",
"draft": {
"channel": "…",
"contactId": "<ID>",
"toName": "…",
"toAddress": "…",
"from": "…",
"reply": true,
"subject": "…",
"body": "…",
"cc": [
"…"
]
}
}
],
"inAppCard": {
"title": "…",
"url": "…"
},
"error": "…"
}
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
idempotency_conflictA request with this Idempotency-Key is still in flight.
Idempotency
Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →