Update experiment by id | Opik Documentation

PATCH/v1/private/experiments/{id}Update experiment by id

Update experiment by id

Parameters

idstring · uuidpathrequired

Request body

application/json

objectExperimentUpdate

experiment_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

metadataobject

namestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

statusstring

The status of the experiment

one of "running", "completed", "cancelled"

tagsarray of 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

idrequiredpath parameter

curl -X PATCH 'http://localhost:5173/api/v1/private/experiments/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"experiment_scores":[{"name":"string","value":0}],"metadata":{},"name":"string","status":"cancelled","tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"],"type":"mini-batch"}'

const response = await fetch('http://localhost:5173/api/v1/private/experiments/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"experiment_scores":[{"name":"string","value":0}],"metadata":{},"name":"string","status":"cancelled","tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"],"type":"mini-batch"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\",\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"],\"type\":\"mini-batch\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/experiments/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"experiment_scores":[{"name":"string","value":0}],"metadata":{},"name":"string","status":"cancelled","tags":["string"],"tags_to_add":["string"],"tags_to_remove":["string"],"type":"mini-batch"}',
)
print(response.json())

package main

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

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

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\",\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"],\"type\":\"mini-batch\"}"
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/experiments/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\",\"tags\":[\"string\"],\"tags_to_add\":[\"string\"],\"tags_to_remove\":[\"string\"],\"type\":\"mini-batch\"}", 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"
}