Create an automation | Respan Docs

curl -X POST https://api.respan.ai/api/automations/ \
     -H "Authorization: Bearer sk_live_xxxxx" \
     -H "Content-Type: application/json" \
     -d '{
  "automation_slug": "prod_quality_monitor",
  "name": "Production Quality Monitor",
  "automation_type": "online_eval",
  "condition": "cond-12345",
  "evaluator_ids": [
    "eval-quality-uuid",
    "eval-safety-uuid"
  ],
  "configuration": {}
}'

{
  "id": "auto-eval-001",
  "automation_slug": "prod_quality_monitor",
  "name": "Production Quality Monitor",
  "automation_type": "online_eval",
  "condition": {
    "id": "cond-12345",
    "condition_slug": "success_logs",
    "name": "Successful Requests",
    "condition_type": "single_log"
  },
  "evaluator_ids": [
    "eval-quality-uuid",
    "eval-safety-uuid"
  ],
  "evaluator_details": [
    {
      "id": "eval-quality-uuid",
      "name": "Response Quality Evaluator",
      "evaluator_slug": "response_quality",
      "eval_class": "respan_custom_evaluator"
    },
    {
      "id": "eval-safety-uuid",
      "name": "Safety Check",
      "evaluator_slug": "safety_check",
      "eval_class": "respan_custom_evaluator"
    }
  ],
  "is_enabled": true,
  "configuration": {
    "evaluator_ids": [
      "eval-quality-uuid",
      "eval-safety-uuid"
    ],
    "sampling_rate": 0.1
  },
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Create an online evaluation automation that automatically runs evaluators on spans matching specified conditions.

Request

This endpoint expects an object.

automation_slugstringRequired

Unique identifier.

namestringRequired

Human-readable name.

automation_typeenumRequired

Automation type.

Allowed values:

conditionstringRequired

Condition ID (from Create Condition endpoint).

evaluator_idslist of stringsRequired

Evaluator UUIDs to run (from List Evaluators).

configurationobjectRequired

Automation configuration.

is_enabledbooleanOptionalDefaults to false

Whether automation is active.

Response

Successful response for Create automation

idstring

automation_slugstring

namestring

automation_typestring

conditionobject

evaluator_idslist of strings

evaluator_detailslist of objects

is_enabledboolean

configurationobject

created_atstring

updated_atstring

Errors

401

Unauthorized Error

Headers

Request

Response

Errors