Skip to main content

Opik Documentation

Update report preferences

PUT/v1/private/projects/{projectId}/reports/preferencesUpdate report preferences

Enable or disable daily report generation for a project.

Parameters

projectIdstring · uuidpathrequired

Request body

application/json

objectReportPreference

created_atstring · date-time

custom_promptstring

maxLength 5000 · minLength 0

enabledboolean

last_updated_atstring · date-time

project_idstring · uuid

schedule_timestring

pattern \d{2}:\d{2}:\d{2}

Example request

{
  "custom_prompt": "string",
  "enabled": true,
  "project_id": "00000000-0000-0000-0000-000000000000",
  "schedule_time": "string"
}

Responses

objectReportPreference

created_atstring · date-time

custom_promptstring

maxLength 5000 · minLength 0

enabledboolean

last_updated_atstring · date-time

project_idstring · uuid

schedule_timestring

pattern \d{2}:\d{2}:\d{2}

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "custom_prompt": "string",
  "enabled": true,
  "last_updated_at": "2026-06-09T00:00:00Z",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "schedule_time": "string"
}

Examples

projectIdrequiredpath parameter

curl -X PUT 'http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/preferences' \
  -H 'Content-Type: application/json' \
  -d '{"custom_prompt":"string","enabled":true,"project_id":"00000000-0000-0000-0000-000000000000","schedule_time":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/preferences', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"custom_prompt":"string","enabled":true,"project_id":"00000000-0000-0000-0000-000000000000","schedule_time":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/preferences', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"custom_prompt\":\"string\",\"enabled\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"schedule_time\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/preferences",
    headers={"Content-Type": "application/json"},
    data='{"custom_prompt":"string","enabled":true,"project_id":"00000000-0000-0000-0000-000000000000","schedule_time":"string"}',
)
print(response.json())

package main

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

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

require 'net/http'

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

{
  "created_at": "2026-06-09T00:00:00Z",
  "custom_prompt": "string",
  "enabled": true,
  "last_updated_at": "2026-06-09T00:00:00Z",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "schedule_time": "string"
}