Set prompt version environment | Opik Documentation

PATCH/v1/private/prompts/versions/{versionId}/environmentsSet prompt version environment

Set or clear the environment owned by a prompt version. Setting a non-null environment moves ownership atomically: any previous owner of that environment for the same prompt has its environment cleared in the same transaction. Setting null clears the environment from the version. The environment must already exist in the workspace registry; unknown names return 404.

Parameters

versionIdstring · uuidpathrequired

Request body

application/json

objectPromptVersionEnvironmentUpdate

Replace the full set of environments assigned to a prompt version. The provided set becomes the new complete set of environments for this version. - Non-empty set: assigns each environment to this version; if another version of the same prompt currently owns any of those environments, ownership is moved atomically. - Empty set: clears all environments from this version. All environments must already exist in the workspace registry; unknown names return 404.

environmentsarray of stringrequired

maxItems 100 · minItems 0 · uniqueItems true

Show child attributes

maxItems 100 · minItems 0 · uniqueItems true

Example request

{
  "environments": [
    "string"
  ]
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

versionIdrequiredpath parameter

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

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

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

import requests

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

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"environments":["string"]}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "http://localhost:5173/api/v1/private/prompts/versions/00000000-0000-0000-0000-000000000000/environments", 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/00000000-0000-0000-0000-000000000000/environments");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"environments\":[\"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/00000000-0000-0000-0000-000000000000/environments"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"environments\":[\"string\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/prompts/versions/00000000-0000-0000-0000-000000000000/environments")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"environments\":[\"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/00000000-0000-0000-0000-000000000000/environments");
request.Content = new StringContent("{\"environments\":[\"string\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

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

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