Retrieve project | Opik Documentation

POST/v1/private/projects/retrieveRetrieve project

Retrieve project

Request body

application/json

objectProjectRetrieve_Detailed

includeStatsboolean

namestringrequired

minLength 1

Example request

{
  "includeStats": true,
  "name": "string"
}

Responses

objectProject_Detailed

created_atstring · date-time

created_bystring

descriptionstring

maxLength 255 · minLength 0

durationobject

Show child attributes

p50number

p90number

p99number

error_countobject

Show child attributes

countinteger · int64

deviationinteger · int64

deviation_percentageinteger · int64

feedback_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

guardrails_failed_countinteger · int64

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

last_updated_trace_atstring · date-time

namestringrequired

minLength 1

thread_countinteger · int64

total_estimated_costnumber · double

total_estimated_cost_sumnumber · double

trace_countinteger · int64

usageobject

visibilitystring

one of "private", "public"

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "duration": {
    "p50": 0,
    "p90": 0,
    "p99": 0
  },
  "error_count": {
    "count": 0,
    "deviation": 0,
    "deviation_percentage": 0
  },
  "feedback_scores": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "guardrails_failed_count": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "last_updated_trace_at": "2026-06-09T00:00:00Z",
  "name": "string",
  "thread_count": 0,
  "total_estimated_cost": 0,
  "total_estimated_cost_sum": 0,
  "trace_count": 0,
  "usage": {
    "additionalProp1": 0
  },
  "visibility": "private"
}

objectErrorMessage_Detailed

errorsarray of string

Show child attributes

Example response

{
  "errors": [
    "string"
  ]
}

objectErrorMessage_Detailed

errorsarray of string

Show child attributes

Example response

{
  "errors": [
    "string"
  ]
}

objectErrorMessage_Detailed

errorsarray of string

Show child attributes

Example response

{
  "errors": [
    "string"
  ]
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/projects/retrieve' \
  -H 'Content-Type: application/json' \
  -d '{"includeStats":true,"name":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/projects/retrieve', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"includeStats":true,"name":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/retrieve', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"includeStats\":true,\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/projects/retrieve",
    headers={"Content-Type": "application/json"},
    data='{"includeStats":true,"name":"string"}',
)
print(response.json())

package main

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

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

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/projects/retrieve")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"includeStats\":true,\"name\":\"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.Post, "http://localhost:5173/api/v1/private/projects/retrieve");
request.Content = new StringContent("{\"includeStats\":true,\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "duration": {
    "p50": 0,
    "p90": 0,
    "p99": 0
  },
  "error_count": {
    "count": 0,
    "deviation": 0,
    "deviation_percentage": 0
  },
  "feedback_scores": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "guardrails_failed_count": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "last_updated_trace_at": "2026-06-09T00:00:00Z",
  "name": "string",
  "thread_count": 0,
  "total_estimated_cost": 0,
  "total_estimated_cost_sum": 0,
  "trace_count": 0,
  "usage": {
    "additionalProp1": 0
  },
  "visibility": "private"
}

{
  "errors": [
    "string"
  ]
}

{
  "errors": [
    "string"
  ]
}

{
  "errors": [
    "string"
  ]
}