Voice Agent Questions

Create Question

Create Question

Requires the OWNER or ADMIN role. Attaches a question template to an agent. agentId and templateId are both required; both must belong to your company (or, for templateId, be a public system template). Returns 404 if either is not found.

post/voice/questions

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/voice/questions
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Request body

agentIdstring required

Required.

templateIdstring required

Required. Must reference a template your company can see (its own, or a system template).

requiredboolean
maxPromptAttemptsnumber
noResponseBehavior'move_to_next_question' | 'end_conversation'
triggerConditionstring
ordernumber
enabledboolean
mappedFieldIdstring nullable

Id of an existing company Field to write this question's collected answer onto after each call.

Response

Created

status'success'

Changes

No recorded changes to this operation across all 2 revisions of this API.