Update Agent Insights job | Opik Documentation

PATCH/v1/private/agent-insights/jobs/{projectId}Update Agent Insights job

Partially updates the Agent Insights job for a project (e.g. status; never deletes). Returns the updated job, or 404 if none exists.

Parameters

projectIdstring · uuidpathrequired

Request body

required

application/json

objectAgentInsightsJobUpdate

statusstringrequired

New status for the job

one of "enabled", "disabled"

Example request

{
  "status": "disabled"
}

Responses

objectAgentInsightsJob

created_atstring · date-time

created_bystring

idstring · uuid

last_failed_atstring · date-time

last_failure_detailstring

last_failure_reasonstring

last_scan_atstring · date-time

last_updated_atstring · date-time

last_updated_bystring

project_idstring · uuidrequired

statusstring

one of "enabled", "disabled"

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_failed_at": "2026-06-09T00:00:00Z",
  "last_failure_detail": "string",
  "last_failure_reason": "string",
  "last_scan_at": "2026-06-09T00:00:00Z",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "status": "disabled"
}

Examples

projectIdrequiredpath parameter

curl -X PATCH 'http://localhost:5173/api/v1/private/agent-insights/jobs/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"status":"disabled"}'

const response = await fetch('http://localhost:5173/api/v1/private/agent-insights/jobs/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"status":"disabled"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/agent-insights/jobs/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"status\":\"disabled\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/agent-insights/jobs/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"status":"disabled"}',
)
print(response.json())

package main

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

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

require 'net/http'

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

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_failed_at": "2026-06-09T00:00:00Z",
  "last_failure_detail": "string",
  "last_failure_reason": "string",
  "last_scan_at": "2026-06-09T00:00:00Z",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "status": "disabled"
}