Versions And Prompt Review
Review An Agent Prompt
Run DialNexa agent prompt review checks before publishing a Single Prompt Agent or Conversational Flow Agent version.
POST
Review An Agent Prompt
Changes state - verify before retry
Review an agent prompt before publishing. The operation can check instructions, variables, speech quality, contradictions, hallucination risks, language, model fallback, post-call capture, and call-handling settings without editing or publishing the agent version.
When To Use Agent Prompt Review
- Check a draft prompt before creating an immutable version.
- Review only the check groups relevant to your release gate.
- Generate a
fix_prefillinstruction that can be sent to an editing assistant. - Recheck after changing the prompt or the names of its default variables. A stored report is reused when only other settings changed (see below).
Before You Call It
- Use an
agent_ID from List Agents. - Use a version number returned by Get Agent Details.
- Keep
prompt_textat100,000characters or fewer. Omit it to review the stored version prompt. - An empty or whitespace-only
prompt_textalso falls back to the stored prompt.
Choose Prompt Review Checks
Omitchecks to run every available group. Send a smaller list when you need a faster focused review.
The
unknowable, conflicts, structure, and speech groups use a model-based check. Leave all four out to avoid model calls.
Response Fields
Side Effects And Retry Safety
This operation does not edit or publish the agent version. It can run billable model work, may take several seconds, and can store a complete report for reuse. Complete, non-degraded reports are cached by the prompt, the version’s default variable names, and the requested checks. Other settings such as languages, models, knowledge bases, post-call fields, and timeouts are not part of that key, so after changing only those settings the stored report is returned withcached: true; change the checks list to force a fresh review. Degraded reports are not cached so a later request can retry the full review.
It is safe to retry after a timeout, but first allow enough time for the original review to finish. An identical completed request can return the cached report.
Verify The Result
Checkdegraded before treating the review as complete. Review every item where acknowledged is false, then either revise the prompt or record a decision with Acknowledge A Prompt Review Finding. Publishing remains a separate user action.
Operation-Specific Errors
Related Lifecycle Operations
- Get Agent Details to find version numbers and the stored prompt.
- Update Agent to revise a draft before publishing.
- Acknowledge A Prompt Review Finding to accept or dismiss one reviewed finding.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Signed agent ID.
Agent version number to review.
Body
application/json
Check groups to run. Omit for all. unknowable, conflicts, structure and speech call a model; leave all four out to avoid model work.
Available options:
structure, variables, speech, unknowable, conflicts, language, models, capture, call_handling Prompt text to review instead of the stored prompt, up to 100,000 characters. Empty or whitespace falls back to the stored prompt. The version must still exist in your workspace.
Maximum string length:
100000