For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETFind alerts by project
        • GETFind dashboards by project
        • GETFind datasets by project
        • GETFind experiments by project
        • GETFind optimizations by project
        • GETGet prompts by project
        • GETFind projects
        • POSTCreate project
        • GETGet project by id
        • DELDelete project by id
        • PATCHUpdate project by id
        • POSTDelete projects
        • GETFind Feedback Score names By Project Ids
        • GETFind Token Usage names
        • POSTGet Project KPI Cards
        • POSTGet Project Metrics
        • GETGet Project Stats
        • POSTRetrieve project
        • GETGet recent activity for a project
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceProjects

Retrieve project

POST
/v1/private/projects/retrieve
POST
/api/v1/private/projects/retrieve
$curl -X POST http://localhost:5173/api/v1/private/projects/retrieve \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "string"
>}'
1{
2  "name": "string",
3  "id": "string",
4  "visibility": "private",
5  "description": "string",
6  "created_at": "2024-01-15T09:30:00Z",
7  "created_by": "string",
8  "last_updated_at": "2024-01-15T09:30:00Z",
9  "last_updated_by": "string",
10  "last_updated_trace_at": "2024-01-15T09:30:00Z",
11  "feedback_scores": [
12    {
13      "name": "string",
14      "value": 1.1
15    }
16  ],
17  "duration": {
18    "p50": 1.1,
19    "p90": 1.1,
20    "p99": 1.1
21  },
22  "total_estimated_cost": 1.1,
23  "total_estimated_cost_sum": 1.1,
24  "usage": {},
25  "trace_count": 1,
26  "thread_count": 1,
27  "guardrails_failed_count": 1,
28  "error_count": {
29    "count": 1,
30    "deviation": 1,
31    "deviation_percentage": 1
32  }
33}
Retrieve project
Was this page helpful?
Previous

Get recent activity for a project

Next
Built with

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