Update optimization by id | Opik Documentation

PUT/v1/private/optimizations/{id}Update optimization by id

Update optimization by id

Parameters

idstring · uuidpathrequired

Request body

application/json

objectOptimizationUpdate

error_infoobject

Show child attributes

exception_typestringrequired

minLength 1

messagestring

tracebackstringrequired

minLength 1

metadataobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

namestring

statusstring

one of "running", "completed", "cancelled", "initialized", "error"

Example request

{
  "error_info": {
    "exception_type": "string",
    "message": "string",
    "traceback": "string"
  },
  "metadata": {},
  "name": "string",
  "status": "cancelled"
}

Responses

Examples

idrequiredpath parameter

curl -X PUT 'http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"error_info":{"exception_type":"string","message":"string","traceback":"string"},"metadata":{},"name":"string","status":"cancelled"}'

const response = await fetch('http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"error_info":{"exception_type":"string","message":"string","traceback":"string"},"metadata":{},"name":"string","status":"cancelled"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"error_info":{"exception_type":"string","message":"string","traceback":"string"},"metadata":{},"name":"string","status":"cancelled"}',
)
print(response.json())

package main

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

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

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\"}"
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.Put, "http://localhost:5173/api/v1/private/optimizations/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"metadata\":{},\"name\":\"string\",\"status\":\"cancelled\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)