Skip to navigation

Replay

Returns the alternative response(s) the assistant would have produced for this conversation turn given changes to the system prompt or model.

Only assistant items from ended conversations can be replayed. Omit the request body to use the original prompt and model. Set model to compare the same turn on another model available to your workspace.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Path parameters

idstringRequired
The ID of the conversation item to replay.

Request

This endpoint expects an object.
modelenum or stringOptional

Optional model override for this replay. Omit it to use the original model. Select a model available to your workspace. Phonic 0.5 (phonic-0.5) is deprecated and remains available only to customers who used it before Phonic 1 launched. The conversation’s saved intelligence level is retained.

system_promptstringOptional
The system prompt to use when generating replay responses. Use this to test prompt changes against this conversation turn. Omit it to replay the turn with the system prompt it originally ran with.
num_responsesintegerOptional1-200Defaults to 1
Number of alternative responses to generate.

Response

Success response
responseslist of objects
Alternative responses generated for the conversation item.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error