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

Get project by id

GET
/v1/private/projects/:id
GET
/api/v1/private/projects/:id
$curl http://localhost:5173/api/v1/private/projects/id
200Retrieved
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}
Get project by id
Was this page helpful?
Previous

Delete project by id

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

Project resource
namestring>=1 character
idstringRead-onlyformat: "uuid"
visibilityenum
Allowed values:
descriptionstring0-255 characters
created_atstringRead-onlyformat: "date-time"
created_bystringRead-only
last_updated_atstringRead-onlyformat: "date-time"
last_updated_bystringRead-only
last_updated_trace_atstringRead-onlyformat: "date-time"