Complete report generation | Opik Documentation

POST/v1/private/projects/{projectId}/reports/{reportId}/completeComplete report generation

Callback from Ollie to update report status and content after generation.

Parameters

projectIdstring · uuidpathrequired

reportIdstring · uuidpathrequired

Request body

required

application/json

objectReportCompleteRequest

contentstring

failure_reasonstring

Why the report failed. Only 'out_of_credits' is acted on; any other value is recorded but renders as a generic failure.

maxLength 64 · minLength 0

recommended_actionsobject

session_idstring

statusstringrequired

one of "pending", "completed", "failed"

Example request

{
  "content": "string",
  "failure_reason": "string",
  "recommended_actions": {},
  "session_id": "string",
  "status": "completed"
}

Responses

Examples

projectIdrequiredpath parameter

reportIdrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete' \
  -H 'Content-Type: application/json' \
  -d '{"content":"string","failure_reason":"string","recommended_actions":{},"session_id":"string","status":"completed"}'

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"content":"string","failure_reason":"string","recommended_actions":{},"session_id":"string","status":"completed"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"content\":\"string\",\"failure_reason\":\"string\",\"recommended_actions\":{},\"session_id\":\"string\",\"status\":\"completed\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete",
    headers={"Content-Type": "application/json"},
    data='{"content":"string","failure_reason":"string","recommended_actions":{},"session_id":"string","status":"completed"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"content":"string","failure_reason":"string","recommended_actions":{},"session_id":"string","status":"completed"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete", 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/00000000-0000-0000-0000-000000000000/complete");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"content\":\"string\",\"failure_reason\":\"string\",\"recommended_actions\":{},\"session_id\":\"string\",\"status\":\"completed\"}");
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/00000000-0000-0000-0000-000000000000/complete"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"content\":\"string\",\"failure_reason\":\"string\",\"recommended_actions\":{},\"session_id\":\"string\",\"status\":\"completed\"}"))
    .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/00000000-0000-0000-0000-000000000000/complete")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"content\":\"string\",\"failure_reason\":\"string\",\"recommended_actions\":{},\"session_id\":\"string\",\"status\":\"completed\"}"
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.Post, "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/00000000-0000-0000-0000-000000000000/complete");
request.Content = new StringContent("{\"content\":\"string\",\"failure_reason\":\"string\",\"recommended_actions\":{},\"session_id\":\"string\",\"status\":\"completed\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)