Update prompt versions | Opik Documentation

PATCH/v1/private/prompts/versionsUpdate prompt versions

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 body

application/json

objectPromptVersionBatchUpdate

Request to update one or more prompt versions. Note: Prompt versions are immutable by design - only organizational properties (such as tags etc.) can be updated.

idsarray of string · uuidrequired

IDs of prompt versions to update

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

merge_tagsboolean

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

default false

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.

Show child attributes

tagsarray of string

Tags to set or merge with existing tags. Follows PATCH semantics: - If merge_tags is true, these tags will be added to existing tags. - If merge_tags is false, these tags will replace all existing tags. - null: preserve existing tags (no change). - empty set: clear all tags when merge_tags is false.

maxItems 50 · minItems 0 · uniqueItems true

Show child attributes

maxItems 50 · minItems 0 · uniqueItems true

Example request

{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "merge_tags": false,
  "update": {
    "tags": [
      "string"
    ]
  }
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X PATCH 'http://localhost:5173/api/v1/private/prompts/versions' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":false,"update":{"tags":["string"]}}'

const response = await fetch('http://localhost:5173/api/v1/private/prompts/versions', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":false,"update":{"tags":["string"]}}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/prompts/versions', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":false,\"update\":{\"tags\":[\"string\"]}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/prompts/versions",
    headers={"Content-Type": "application/json"},
    data='{"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":false,"update":{"tags":["string"]}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"ids":["00000000-0000-0000-0000-000000000000"],"merge_tags":false,"update":{"tags":["string"]}}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "http://localhost:5173/api/v1/private/prompts/versions", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/prompts/versions");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":false,\"update\":{\"tags\":[\"string\"]}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/prompts/versions"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":false,\"update\":{\"tags\":[\"string\"]}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/prompts/versions")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":false,\"update\":{\"tags\":[\"string\"]}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "http://localhost:5173/api/v1/private/prompts/versions");
request.Content = new StringContent("{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"merge_tags\":false,\"update\":{\"tags\":[\"string\"]}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}