Skip to main content
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_prefill instruction that can be sent to an editing assistant.
  • Recheck the same content after changing the prompt or version configuration.

Before You Call It

  • Use an agent_ ID from List Agents.
  • Use a version number returned by Get Agent Details.
  • Keep prompt_text at 100,000 characters or fewer. Omit it to review the stored version prompt.
  • An empty or whitespace-only prompt_text also falls back to the stored prompt.

Choose Prompt Review Checks

Omit checks to run every available group. Send a smaller list when you need a faster focused review. The unknowable and conflicts groups use model-based checks. Leaving both out avoids those 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 can be cached for identical inputs. 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

Check degraded 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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

Signed agent ID.

Example:

"agent_2g7Xy3tY53gRlp"

versionNumber
integer
required

Agent version number to review.

Required range: x >= 1
Example:

1

Body

application/json
prompt_text
string

Draft prompt text to review instead of the stored version prompt. Omit or send blank text to use the stored prompt.

Maximum string length: 100000
checks
enum<string>[]

Check groups to run. Omit to run every group.

Available options:
structure,
variables,
speech,
unknowable,
conflicts,
language,
models,
capture,
call_handling

Response

Prompt review completed.

review_fingerprint
string
required

SHA-256 fingerprint of the reviewed inputs.

findings
object[]
required
new_warning_count
integer
required
Required range: x >= 0
reviewed_at
string<date-time>
required
degraded
boolean
required
cached
boolean
required
fix_prefill
string
required