Retrieve project | Opik Documentation

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

{
  "name": "AlphaProject",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "visibility": "private",
  "description": "This project focuses on developing the next generation AI model for natural language processing.",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "jane.doe@example.com",
  "last_updated_at": "2024-04-10T14:45:00Z",
  "last_updated_by": "john.smith@example.com",
  "last_updated_trace_at": "2024-04-10T14:50:00Z",
  "feedback_scores": [
    {
      "name": "accuracy",
      "value": 92.5
    }
  ],
  "duration": {
    "p50": 120.5,
    "p90": 250.75,
    "p99": 400
  },
  "total_estimated_cost": 15000.75,
  "total_estimated_cost_sum": 45000.25,
  "usage": {},
  "trace_count": 350,
  "thread_count": 8,
  "guardrails_failed_count": 2,
  "error_count": {
    "count": 5,
    "deviation": 1,
    "deviation_percentage": 20
  }
}

Retrieve project

Request

This endpoint expects an object.

namestringRequired>=1 character

Response

Project resource

namestring>=1 character

idstringRead-onlyformat: "uuid"

visibilityenum

Allowed values:

descriptionstring0-255 characters

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetimeRead-only

last_updated_bystringRead-only

last_updated_trace_atdatetimeRead-only

feedback_scoreslist of objectsRead-only

durationobjectRead-only

total_estimated_costdoubleRead-only

total_estimated_cost_sumdoubleRead-only

usagemap from strings to doublesRead-only

trace_countlongRead-only

thread_countlongRead-only

guardrails_failed_countlongRead-only

error_countobjectRead-only

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error