Create a new evaluator

Create a new evaluator

POST /api/v1/evaluators

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/evaluators"

payload = {
    "name": "<string>",
    "config": {}
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "type": "<string>",
  "config": {},
  "workflowId": "<string>",
  "copiedFromEvaluatorId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "fields": [
    {
      "identifier": "<string>",
      "type": "<string>",
      "optional": true
    }
  ],
  "outputFields": [
    {
      "identifier": "<string>",
      "type": "<string>",
      "optional": true
    }
  ],
  "version": 4503599627370495,
  "labels": [
    {
      "label": "<string>",
      "version": 123
    }
  ],
  "createdBy": {
    "id": "<string>",
    "name": "<string>"
  },
  "updatedBy": {
    "id": "<string>",
    "name": "<string>"
  },
  "platformUrl": "<string>",
  "workflowName": "<string>",
  "workflowIcon": "<string>"
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Body

application/json

name · string · required

Required string length: 1 - 255

config · object · required

Show child attributes

Response

200 - application/json

Success

id · string · required

projectId · string · required

name · string · required

slug · string | null · required

type · string · required

config · object | null · required

Show child attributes

workflowId · string | null · required

copiedFromEvaluatorId · string | null · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

fields · object[] · required

Show child attributes

outputFields · object[] · required

Show child attributes

version · integer | null · required

The version this response shows: the latest, unless a label or a version was asked for.

Required range: 0 < x <= 9007199254740991

labels · object[] · required

The deploy labels the evaluator carries, such as production, and the version each points at.

Show child attributes

createdBy · object | null · required

The user who created the evaluator. Null when an API key created it, or it predates creators being recorded.

Show child attributes

updatedBy · object | null · required

The user who changed the evaluator last. Null when an API key changed it.

Show child attributes

platformUrl · string<uri> · required

workflowName · string

workflowIcon · string