{ "opencollection": "1.0.0", "info": { "name": "Opik REST Projects API", "version": "1.0.0" }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Find alerts by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/alerts", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find alerts scoped to a project" }, { "info": { "name": "Find dashboards by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/dashboards", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find dashboards scoped to a project" }, { "info": { "name": "Find datasets by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/datasets", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "with_experiments_only", "value": "", "type": "query" }, { "name": "with_optimizations_only", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find datasets scoped to a project" }, { "info": { "name": "Find experiments by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/experiments", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "datasetId", "value": "", "type": "query" }, { "name": "optimization_id", "value": "", "type": "query" }, { "name": "types", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "dataset_deleted", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "experiment_ids", "value": "", "type": "query" }, { "name": "force_sorting", "value": "", "type": "query" } ] }, "docs": "Find experiments scoped to a project" }, { "info": { "name": "Find optimizations by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/optimizations", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "dataset_id", "value": "", "type": "query" }, { "name": "dataset_name", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "dataset_deleted", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find optimizations scoped to a project" }, { "info": { "name": "Get prompts by project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/prompts", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Get prompts scoped to a project" }, { "info": { "name": "Find projects", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" } ] }, "docs": "Find projects" }, { "info": { "name": "Create project", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Create project" }, { "info": { "name": "Get project by id", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get project by id" }, { "info": { "name": "Update project by id", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:5173/api/v1/private/projects/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update project by id" }, { "info": { "name": "Delete project by id", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:5173/api/v1/private/projects/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete project by id" }, { "info": { "name": "Delete projects", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/projects/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete projects batch" }, { "info": { "name": "Find Feedback Score names By Project Ids", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/feedback-scores/names", "params": [ { "name": "project_ids", "value": "", "type": "query" } ] }, "docs": "Find Feedback Score names By Project Ids" }, { "info": { "name": "Find Token Usage names", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:id/token-usage/names", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Find Token Usage names" }, { "info": { "name": "Get Project KPI Cards", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/projects/:id/kpi-cards", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets KPI card metrics for a project" }, { "info": { "name": "Get Project Metrics", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/projects/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets specified metrics for a project" }, { "info": { "name": "Get Project Stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/stats", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" } ] }, "docs": "Get Project Stats" }, { "info": { "name": "Retrieve project", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/projects/retrieve", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve project" }, { "info": { "name": "Get recent activity for a project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/projects/:projectId/activities", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "Returns the most recent activity items across all entity types for a project, sorted by date descending." } ] } ], "bundled": true }