Browse the API reference

Assistants

Check an assistant's setup

View as Markdown
posthttps://www.getrevox.com/api/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.

Path parameters

  • idstringrequired

Request body

  • localeenum (string)required

    Language of the issue messages.

    One offren

  • dismissinteger

    Index of an issue to ignore: it is no longer returned until the setup changes.

    min -9007199254740991 · max 9007199254740991

Responses

200Success
404Not found in your organization
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants
        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring