Check an assistant's setup

POST/assistants/{id}/setup-check

Check a saved assistant for the setup mistakes that break real calls: a persona whose gender doesn't match the voice, a prompt that transfers or books with no transfer destination or calendar connected, template text left in, the wrong language, wording that reads wrong once variables are filled. Call it after your last change to the assistant. Returns at most one issue per kind, each with the fix to apply when one exists; an empty list means nothing major was found. The result is stored: while the setup is unchanged it comes back instantly, a fresh check takes a few seconds. Multi-step assistants are not checked.

Request

curl -X POST "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/setup-check" \
  -H "Authorization: Bearer $REVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "locale": "en" }'

const res = await fetch("https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/setup-check", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    locale: "en",
  }),
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.post(
    "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/setup-check",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    json={
        "locale": "en",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

Issue messages in English.

Try itSend this request live

Response

Success

{
  "issues": [
    {
      "message": "Hello, this is Julie from Acme.",
      "fix": {
        "type": "text",
        "field": "prompt",
        "find": "{{firstname}}",
        "replace": "{{first_name}}"
      }
    }
  ]
}

{ "error": "Not found" }

Path parameters

idstringrequired
ID of the assistant, as returned by GET /assistants.

Request body

application/json

locale"fr" | "en"required
Language of the issue messages.
dismissinteger
Index of an issue to ignore: it is no longer returned until the setup changes.

Response

200

issuesarray of AssistantSetupIssue
The major problems found, at most one per kind. Empty when nothing major was found.

Errors

404Not found in your organization{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.