Voice Agent Testing

Apply Test Run Recommendation

Apply Recommendation

Requires the OWNER or ADMIN role. Applies a recommendation's quick action to the agent:

  • patch_instructions / instructions — appends the recommendation's suggested fix to the agent's instructions.
  • update_personality / personality — appends it to the agent's personality.
  • add_topic_to_avoid / topics_to_avoid — adds it to chatSettings.topicsToAvoid.
  • add_lexicon_term / lexicon / add_to_kb / kb — marked applied but makes no change to the agent. These two categories are not wired up yet; the run record reflects the acknowledgement, the agent config does not.

Any other action type returns 400. A recommendation with no suggestedFix also returns 400.

post/voice/testing/{agentId}/runs/{runId}/recommendations/{recId}/apply

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/voice/testing/{agentId}/runs/{runId}/recommendations/{recId}/apply
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

agentIdstring required
runIdstring required
recIdstring required

Response

OK

status'success'

Changes

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