Update prompt versions | Opik Documentation

Update one or more prompt versions.

Note: Prompt versions are immutable by design. Only organizational properties, such as tags etc., can be updated. Core properties like template and metadata cannot be modified after creation.

PATCH semantics:

non-empty values update the field
null values preserve existing field values (no change)
empty values explicitly clear the field

Update one or more prompt versions. Note: Prompt versions are immutable by design. Only organizational properties, such as tags etc., can be updated. Core properties like template and metadata cannot be modified after creation. PATCH semantics: - non-empty values update the field - null values preserve existing field values (no change) - empty values explicitly clear the field

Request

This endpoint expects an object.

idslist of stringsRequired

IDs of prompt versions to update

updateobjectRequired

Update to apply to prompt versions. Note: Prompt versions are immutable by design. Only organizational properties (such as tags etc.) can be updated. Core properties like template, metadata etc. cannot be modified after creation.

merge_tagsbooleanOptionalDefaults to false

Tag merge behavior:

true: Add new tags to existing tags (union)
false: Replace all existing tags with new tags (default behaviour if not provided)

Tag merge behavior: - true: Add new tags to existing tags (union) - false: Replace all existing tags with new tags (default behaviour if not provided)

Response

No Content

1	import requests
2
3	url = "http://localhost:5173/api/v1/private/prompts/versions"
4
5	payload = { "ids": ["string"] }
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.patch(url, json=payload, headers=headers)
9
10	print(response.json())

Request

Response

Errors