Retrieve project | Opik Documentation

1 curl -X POST http://localhost:5173/api/v1/private/projects/retrieve \ 2 -H "Content-Type: application/json" \ 3 -d '{ 4 "name": "foo" 5 }'

1 { 2 "name": "foo", 3 "id": "foo", 4 "visibility": "private", 5 "description": "foo", 6 "created_at": "foo", 7 "created_by": "foo", 8 "last_updated_at": "foo", 9 "last_updated_by": "foo", 10 "last_updated_trace_at": "foo", 11 "feedback_scores": [ 12 { 13 "name": "foo", 14 "value": 42 15 } 16 ], 17 "duration": { 18 "p50": 42, 19 "p90": 42, 20 "p99": 42 21 }, 22 "total_estimated_cost": 42, 23 "total_estimated_cost_sum": 42, 24 "usage": {}, 25 "trace_count": 42, 26 "guardrails_failed_count": 42, 27 "error_count": { 28 "count": 42, 29 "deviation": 42, 30 "deviation_percentage": 42 31 }, 32 "configuration": { 33 "timeout_to_mark_thread_as_inactive": { 34 "seconds": 42, 35 "zero": true, 36 "nano": 42, 37 "negative": true, 38 "positive": true, 39 "units": [ 40 { 41 "durationEstimated": true, 42 "duration": { 43 "seconds": 42, 44 "zero": true, 45 "nano": 42, 46 "negative": true, 47 "positive": true 48 }, 49 "timeBased": true, 50 "dateBased": true 51 } 52 ] 53 } 54 } 55 }

Retrieve project

Request

This endpoint expects an object.

namestringRequired>=1 character

Response

Project resource

namestring>=1 character

idstring or nullformat: "uuid"

visibilityenum or null

Allowed values:

descriptionstring or null

created_atstring or nullformat: "date-time"

created_bystring or null

last_updated_atstring or nullformat: "date-time"

last_updated_bystring or null

last_updated_trace_atstring or nullformat: "date-time"

feedback_scoreslist of objects or null

durationobject or null

total_estimated_costdouble or null

total_estimated_cost_sumdouble or null

usagemap from strings to doubles or null

trace_countlong or null

guardrails_failed_countlong or null

error_countobject or null

configurationobject or null

Request

Response

Errors