Get refined prompt

GET

Get the refined prompt based on the refinement_job_id.

Path parameters

prompt_idintegerRequired

Prompt ID

version_idintegerRequired

Prompt Version ID

Query parameters

refinement_job_idstringRequired

Refinement Job ID acquired from the POST /api/prompts/{prompt_id}/versions/{version_id}/refine endpoint

Response

promptstring

The refined prompt text

titlestringOptional

Title of the refined prompt

reasoningstringOptional

Reasoning behind the refinement

refinement_job_idstringOptional

Unique identifier for the refinement job

refinement_statusenumOptionalDefaults to Pending
Allowed values: PendingInProgressCompletedFailed

Status of the refinement job

total_coststringOptional

Total cost of the refinement job (in USD)

previous_versionobjectOptional

Previous version of the prompt

Built with