{ "opencollection": "1.0.0", "info": { "name": "Opik REST Experiments API", "version": "1.0.0" }, "items": [ { "info": { "name": "Experiments", "type": "folder" }, "items": [ { "info": { "name": "Batch update experiments", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:5173/api/v1/private/experiments/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple experiments" }, { "info": { "name": "Find experiments", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments", "params": [ { "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": "prompt_id", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "project_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" }, { "info": { "name": "Create experiment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments", "body": { "type": "json", "data": "{}" } }, "docs": "Create experiment" }, { "info": { "name": "Create experiment items", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/items", "body": { "type": "json", "data": "{}" } }, "docs": "Create experiment items" }, { "info": { "name": "Delete experiment items", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/items/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete experiment items" }, { "info": { "name": "Delete experiments by id", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete experiments by id" }, { "info": { "name": "Create and execute experiment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/execute", "body": { "type": "json", "data": "{}" } }, "docs": "Creates experiments for each prompt variant and asynchronously processes all dataset items" }, { "info": { "name": "Record experiment items in bulk", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:5173/api/v1/private/experiments/items/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Record experiment items in bulk with traces, spans, and feedback scores. Maximum request size is 4MB." }, { "info": { "name": "Find Feedback Score names", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments/feedback-scores/names", "params": [ { "name": "experiment_ids", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" } ] }, "docs": "Find Feedback Score names" }, { "info": { "name": "Find experiment groups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments/groups", "params": [ { "name": "groups", "value": "", "type": "query" }, { "name": "types", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "project_deleted", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find experiments grouped by specified fields" }, { "info": { "name": "Find experiment groups with aggregations", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments/groups/aggregations", "params": [ { "name": "groups", "value": "", "type": "query" }, { "name": "types", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "project_deleted", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Find experiments grouped by specified fields with aggregation metrics" }, { "info": { "name": "Finish experiments", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/finish", "body": { "type": "json", "data": "{}" } }, "docs": "Finish experiments and trigger alert events" }, { "info": { "name": "Get experiment by id", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get experiment by id" }, { "info": { "name": "Update experiment by id", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:5173/api/v1/private/experiments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update experiment by id" }, { "info": { "name": "Get experiment item by id", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:5173/api/v1/private/experiments/items/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get experiment item by id" }, { "info": { "name": "Stream experiment items", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/items/stream", "body": { "type": "json", "data": "{}" } }, "docs": "Stream experiment items" }, { "info": { "name": "Stream experiments", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:5173/api/v1/private/experiments/stream", "body": { "type": "json", "data": "{}" } }, "docs": "Stream experiments" } ] } ], "bundled": true }