Skip to main content
POST
Suggest a Fix

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Path Parameters

id
string<uuid>
required

Test suite ID

attemptId
string<uuid>
required

Test attempt ID, from a test run's attempts

Query Parameters

wait
enum<string>

Set to 0 to return immediately instead of waiting for the suggestion.

Available options:
0

Body

application/json
callbackUrl
string

Optional URL to notify when the suggestion finishes. We POST the completed job there (event test.suggestion.completed, with the same fields as the GET response), so you can stop polling. One delivery attempt, 8 second timeout.

Response

The suggestion, when it was ready in time. The suggestion fields are also present at the top level of data.

data
object

A proposed prompt change that would make a failed test pass.