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 project Evaluators
        • POSTCreate automation rule evaluator
        • POSTDelete automation rule evaluators
        • GETGet automation rule evaluator by id
        • PATCHUpdate Automation Rule Evaluator by id
        • GETGet automation rule evaluator logs by id
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAutomation Rule Evaluators

Find project Evaluators

GET
/v1/private/automations/evaluators
GET
/api/v1/private/automations/evaluators
$curl http://localhost:5173/api/v1/private/automations/evaluators
200Retrieved
1{
2 "page": 1,
3 "size": 1,
4 "total": 1,
5 "content": [
6 {
7 "type": "llm_as_judge",
8 "action": "evaluator",
9 "name": "string",
10 "created_at": "2024-01-15T09:30:00Z",
11 "created_by": "string",
12 "enabled": true,
13 "id": "string",
14 "last_updated_at": "2024-01-15T09:30:00Z",
15 "last_updated_by": "string",
16 "project_id": "string",
17 "project_name": "string",
18 "projects": [
19 {
20 "project_id": "string",
21 "project_name": "string"
22 }
23 ],
24 "sampling_rate": 1.1
25 }
26 ],
27 "sortable_by": [
28 "string"
29 ]
30}
Find project Evaluators
Was this page helpful?
Previous

Create automation rule evaluator

Next
Built with

Query parameters

project_idstringOptionalformat: "uuid"
idstringOptional
namestringOptional
filtersstringOptional
sortingstringOptional
pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10

Response

Evaluators resource
pageinteger
sizeinteger
totallong
contentlist of objects
sortable_bylist of strings