Refine a prompt version | API Reference

Refine a prompt version using a teacher model and save the refined prompt as a new version.

prompt_idintegerRequired

Prompt ID

version_idintegerRequired

Base Prompt Version ID

asyncbooleanOptional

Run the refinement job asynchronously

This endpoint expects an object.

teacher_model_provider_connection_idintegerOptional

Model Provider Connection ID to use to refine the prompt

teacher_model_namestringOptional

Name of the model to use to refine the prompt

project_idintegerOptional

Project ID to target the refined prompt for

promptstring

The refined prompt text

titlestring or null

Title of the refined prompt

reasoningstring or null

Reasoning behind the refinement

refinement_job_idstring or null

Unique identifier for the refinement job

refinement_statusenum or nullDefaults to Pending

Status of the refinement job

Allowed values:

total_coststring or null

Total cost of the refinement job (in USD)

previous_versionobject or null

Previous version of the prompt

1	curl -X POST http://localhost:8080/api/prompts/1/versions/1/refine \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"prompt": "prompt",
3	"title": "title",
4	"reasoning": "reasoning",
5	"refinement_job_id": "refinement_job_id",
6	"refinement_status": "Pending",
7	"total_cost": "total_cost",
8	"previous_version": {
9	"title": "title",
10	"parent_model": 1,
11	"model_provider_connection": 1,
12	"prompt": "prompt",
13	"provider": "OpenAI",
14	"provider_model_id": "provider_model_id",
15	"created_by": 1,
16	"created_at": "2024-01-15T09:30:00Z",
17	"updated_at": "2024-01-15T09:30:00Z",
18	"organization": 1
19	}
20	}