Sign in

v26

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-081039106.2 KB
Prompt Optimization

Check prompt optimization status

Check the status of a prompt optimization run.

Use this endpoint to poll the status of your optimization request. Processing is asynchronous, so you'll need to check periodically until the status indicates completion.

Status Values:

  • created: Initial state, not yet processing
  • queued: Waiting for processing capacity (check queue_position)
  • processing: Currently optimizing prompts
  • completed: All target models have been processed successfully
  • failed: One or more target models failed to process

Polling Recommendations:

  • Poll every 30-60 seconds during processing
  • Check queue_position if status is 'queued' to estimate wait time
  • Stop polling once status is 'completed' or 'failed'
  • Use GET /v2/prompt/optimizeResults to retrieve results after completion

Queue Position:

  • Only present when status is 'queued'
  • Lower numbers mean earlier processing (position 1 is next)
  • Typical wait time: 1-5 minutes per position

Note: This endpoint only returns status information. To get the actual optimized prompts and evaluation results, use GET /v2/prompt/optimizeResults once status is 'completed'.

get/v2/prompt/optimizeStatus/{optimization_run_id}

Path parameters

optimization_run_idstring required

Response

Successfully retrieved optimization status

optimization_run_idstring required

Unique identifier for this optimization run. Use this to poll status and retrieve optimized prompts when complete

status'created' | 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled' required

Status enum for asynchronous jobs (prompt adaptation, custom router training, etc.).

Represents the current state of a long-running operation:

  • created: Job has been initialized but not yet queued
  • queued: Job is waiting in the queue to be processed
  • processing: Job is currently being executed
  • completed: Job finished successfully and results are available
  • failed: Job encountered an error and did not complete
  • cancelled: Job was cancelled due to a restart operation
queue_positioninteger nullable

Position in queue when status is 'queued'. Lower numbers process sooner. Null when not queued

Example response

{
  "optimization_run_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing"
}