Create a signal set | Runtype Documentation

{
  "signalSet": {
    "builtin": false,
    "createdAt": "2024-03-15T14:30:00Z",
    "createdByUserId": "user_2abc123def456ghi",
    "currentVersionId": "ssv_9f8e7d6c5b4a3210",
    "description": "Monitors conversation health signals including sentiment, engagement, and resolution quality.",
    "id": "ss_1a2b3c4d5e6f7890",
    "lastModifiedSource": "api",
    "name": "Conversation Health Monitor",
    "organizationId": "org_4z3y2x1w0v9u8t7s",
    "preset": "conversation_health",
    "updatedAt": "2024-03-15T14:30:00Z"
  },
  "version": {
    "createdAt": "2024-03-15T14:30:00Z",
    "createdByUserId": "user_2abc123def456ghi",
    "definition": {},
    "id": "ssv_9f8e7d6c5b4a3210",
    "signalSetId": "ss_1a2b3c4d5e6f7890",
    "unit": "turn",
    "versionNumber": 1
  }
}

Create a signal set and its first version from a preset or a definition. Preview it against recent traces, then bind it to an agent.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

namestringRequired1-255 characters

definitionmap from strings to anyOptional

A signal set version: { unit: "turn", context: { priorTurns }, signals: { <key>: { type, instructions, options?, notable?, ... } }, bands: { act, review } }. bool and choice signals go to the decision model; text, number, date, duration, list and estimate go to the extraction model.

descriptionstring or nullOptional<=2000 characters

presetstringOptional

Start from a preset, e.g. “conversation_health”. definition, when also given, replaces it.

Response

Created

signalSetobject

versionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error