Prompt Optimization

Start a new prompt optimization job.

Creates an asynchronous job that optimizes the specified prompt template version. The job will analyze examples from the dataset and generate an improved prompt.

When run_test_after_optimization is True (default), the job will also run baseline and optimized test runs and create a comparison.

Poll GET /prompt-optimization-jobs/{job_id} to check job status.

post/api/v2/projects/{project_id}/prompt-optimization-jobs

Request

Base URL
https://app.freeplay.ai (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/freeplay/apis/freeplay-api/docs/api/v2/projects/:project_id/prompt-optimization-jobs/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

project_idstring required

Request body

prompt_template_version_idstring uuid required

dataset_idstring uuid required

user_instructionsstring nullable

use_best_practicesboolean

use_labelsboolean

use_customer_feedbackboolean

run_test_after_optimizationboolean

Response

PromptOptimizationJobCreatedResponse(job_id: uuid.UUID, status: str, created_at: datetime.datetime)

job_idstring uuid required

statusstring required

created_atstring date-time required

Changes

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