Skip to main content
POST
/
api
/
v2
/
projects
/
{project_id}
/
evaluation-criteria
/
code
Create Code Evaluation Criteria
curl --request POST \
  --url https://api.example.com/api/v2/projects/{project_id}/evaluation-criteria/code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "target_type": "prompt",
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eval_code": "<string>",
  "criteria_type": "1-5",
  "sample_rate": 0,
  "generate_insights": true,
  "language": "python"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "target_type": "prompt",
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "criteria_type": "1-5",
  "sample_rate": 123,
  "is_enabled": true,
  "generate_insights": true,
  "deployed_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "eval_code": "<string>",
    "is_deployed": true,
    "created_at": "<string>"
  },
  "latest_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "eval_code": "<string>",
    "is_deployed": true,
    "created_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
project_id
string
required

Body

application/json
​
name
string
required
​
description
string
required
​
target_type
enum<string>
required
Available options:
prompt,
agent
​
target_id
string<uuid>
required
​
eval_code
string
required
​
criteria_type
enum<string>
required
Available options:
1-5,
1-3,
1-100,
yes-no,
multi-select,
text,
auto-categorization,
code-bool,
code-float
​
sample_rate
number
default:0
​
generate_insights
boolean
default:true
​
language
enum<string>
default:python
Available options:
python,
typescript

Response

201 - application/json

CreateCodeEvalResponse(id: uuid.UUID, name: str, description: Optional[str], target_type: shared.common.TargetType, target_id: uuid.UUID, criteria_type: shared.sqlalchemy.models.AutoEvalCriteriaType, sample_rate: Optional[float], is_enabled: bool, generate_insights: bool, deployed_version: server.api_routes.code_eval_criteria_api_v2.CodeEvalVersionSummary, latest_version: server.api_routes.code_eval_criteria_api_v2.CodeEvalVersionSummary)

​
id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
target_type
enum<string>
required
Available options:
prompt,
agent
​
target_id
string<uuid>
required
​
criteria_type
enum<string>
required
Available options:
1-5,
1-3,
1-100,
yes-no,
multi-select,
text,
auto-categorization,
code-bool,
code-float
​
sample_rate
number | null
required
​
is_enabled
boolean
required
​
generate_insights
boolean
required
​
deployed_version
CodeEvalVersionSummary · object
required
​
latest_version
CodeEvalVersionSummary · object
required