FRfreeplay
Prompt Optimization

Get prompt optimization job status and details.

Returns the current status of the prompt optimization job, including progress information for polling. When complete, includes the optimized_version_id and optionally test_run_id and comparison_id if run_test_after_optimization was True.

get/api/v2/projects/{project_id}/prompt-optimization-jobs/{job_id}

Request

Path parameters

project_idstring required
job_idstring required

Response

PromptOptimizationJobStatusResponse(job_id: uuid.UUID, status: str, prompt_template_id: uuid.UUID, original_version_id: uuid.UUID, run_test_after_optimization: bool, created_at: datetime.datetime, optimized_version_id: Optional[uuid.UUID] = None, test_run_id: Optional[uuid.UUID] = None, comparison_id: Optional[uuid.UUID] = None, changes_summary: Optional[str] = None, error_message: Optional[str] = None, data_sources_used: Optional[server.api_routes.prompt_optimization_jobs_api_v2.DataSourcesUsed] = None, completed_at: Optional[datetime.datetime] = None, progress: Optional[server.api_routes.prompt_optimization_jobs_api_v2.JobProgress] = None)

job_idstring uuid required
statusstring required
prompt_template_idstring uuid required
original_version_idstring uuid required
run_test_after_optimizationboolean required
created_atstring date-time required
optimized_version_idstring uuid nullable
test_run_idstring uuid nullable
comparison_idstring uuid nullable
changes_summarystring nullable
error_messagestring nullable
completed_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.