Update judge label

Update a judge label (currently supports description). For binary judges, true means the judge applied its label, which the app shows under the judge’s name. false means no label was applied. For classification judges, the value is the label, meaning the chosen option.

PATCH/v1/projects/{projectId}/behaviors/{behaviorId}

Authorization

AuthorizationPersonal API key · headerrequired

Your personal API key from Settings > Personal API Keys, sent as Bearer <key>.

X-Organization-IdOrganization ID · headerrequired

The organization to act in. Copy it with Copy organization ID in the organization menu or the settings sidebar.

Path parameters

projectIdstringrequired

behaviorIdstring<uuid>required

Label ID

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Request body

requiredapplication/json

descriptionstring | null

Replacement label description. Omit or pass null to clear it.

Responses

200

Response for status 200

behaviorobjectrequired

Show properties

idstringrequired

created_atstringrequired

organization_idstringrequired

project_idstringrequired

judge_namestringrequired

valuestringrequired

descriptionstring | nullrequired

judge_idstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Personal API keyOrganization IDRemember on this deviceInclude my values in samples

Parameters

projectIdpath*behaviorIdpath*Label ID

Bodyapplication/json

descriptionstringReplacement label description. Omit or pass null to clear it.

Request

curl -X PATCH 'https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/behaviors/YOUR_BEHAVIOR_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Organization-Id: YOUR_ORGANIZATION_ID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "string"
}'

const response = await fetch("https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/behaviors/YOUR_BEHAVIOR_ID", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Organization-Id": "YOUR_ORGANIZATION_ID",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/behaviors/YOUR_BEHAVIOR_ID",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "X-Organization-Id": "YOUR_ORGANIZATION_ID",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"string\"\n}",
)

Response

{
  "behavior": {
    "id": "string",
    "created_at": "string",
    "organization_id": "string",
    "project_id": "string",
    "judge_name": "string",
    "value": "string",
    "description": "string",
    "judge_id": "string"
  }
}