GoliathDevelopersGet an API key
Reference/Ask Goliathgenerated from the gateway manifest

getAgentTurn

One message sent to Ask Goliath.

POST/api/v1/callWRITEreadruns as the key's owner
View as Markdown

One message sent to Ask Goliath (conversationId, turnId): status RUNNING, WAITING_FOR_CALLER (answer questions with answerAgentQuestions), COMPLETED (a card only Goliath answers is inAppCard), FAILED (error) or CANCELLED, and the reply so far. waitSeconds (0-25) holds until the reply finishes. Ask Goliath acts as the key owner, as in the app. Needs a WRITE key.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getAgentTurn",
    "variables": {
      "conversationId": "<conversationId>",
      "turnId": "<turnId>"
    }
  }'
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.getAgentTurn({
  conversationId: '<conversationId>',
  turnId: '<turnId>'
})
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',
  },
  body: JSON.stringify({
    operationId: 'getAgentTurn',
    variables: {
      conversationId: '<conversationId>',
      turnId: '<turnId>'
    }
  }),
})
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.

conversationIdID!required
turnIdID!required
waitSecondsInt

Default 0.

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "externalAgentChatQuery": {
      "agentTurn": {
        "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

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

WRITElistAgentConversationsWRITEstartAgentConversationWRITEprepareAgentConversationWRITEsendAgentMessageWRITEanswerAgentQuestionsWRITEcancelAgentTurn