Retrieve project | Opik Documentation

import requests
url = "http://localhost:5173/api/v1/private/projects/retrieve"
payload = { "name": "string" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "name": "string",
  "id": "string",
  "visibility": "private",
  "description": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "last_updated_trace_at": "2024-01-15T09:30:00Z",
  "feedback_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ],
  "duration": {
    "p50": 1.1,
    "p90": 1.1,
    "p99": 1.1
  },
  "total_estimated_cost": 1.1,
  "total_estimated_cost_sum": 1.1,
  "usage": {},
  "trace_count": 1,
  "thread_count": 1,
  "guardrails_failed_count": 1,
  "error_count": {
    "count": 1,
    "deviation": 1,
    "deviation_percentage": 1
  }
}

Retrieve project

Request

This endpoint expects an object.

namestringRequired>=1 character

Response

Project resource

namestring>=1 character

idstring or nullRead-onlyformat: "uuid"

visibilityenum or null

Allowed values:

descriptionstring or null0-255 characters

created_atstring or nullRead-onlyformat: "date-time"

created_bystring or nullRead-only

last_updated_atstring or nullRead-onlyformat: "date-time"

last_updated_bystring or nullRead-only

last_updated_trace_atstring or nullRead-onlyformat: "date-time"

feedback_scoreslist of objects or nullRead-only

durationobject or nullRead-only

total_estimated_costdouble or nullRead-only

total_estimated_cost_sumdouble or nullRead-only

usagemap from strings to doubles or nullRead-only

trace_countlong or nullRead-only

thread_countlong or nullRead-only

guardrails_failed_countlong or nullRead-only

error_countobject or nullRead-only

Request

Response

Errors