Scheduling Rules

List scheduling rule sets

get

List all scheduling rule sets for the workspace. Optional filters: agent_kind (tms / ketamine / general), is_active. Used by the agent-engine rules engine and by operators inspecting config.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

agent_kindany ofOptional

string · enumOptionalPossible values:

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

429

Rate limited.

get

/v1/{workspace_id}/scheduling-rule-sets

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/scheduling-rule-sets HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "agent_kind": "tms",
      "rule_kind": "clinic_open_hours",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "is_active": true,
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-05-12T12:17:02.096Z",
      "updated_at": "2026-05-12T12:17:02.096Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create a scheduling rule set

post

Create one rule set for (agent_kind, rule_kind). Returns 409 if a row already exists for that key — use PATCH on the existing row or DELETE first.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

agent_kindstring · enumRequiredPossible values:

paramsone ofRequired

Per-rule-kind typed parameters. The rule_kind discriminator field selects the params shape; one row per (agent_kind, rule_kind) per workspace.

or

or

or

or

or

is_activebooleanOptionalDefault: true

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

409

Rule set already exists for this (agent_kind, rule_kind).

422

Invalid request body or rule_kind discriminator.

429

Rate limited.

post

/v1/{workspace_id}/scheduling-rule-sets

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scheduling-rule-sets HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "agent_kind": "tms",
  "params": {
    "rule_kind": "clinic_open_hours",
    "timezone": "text",
    "monday": {
      "start": "text",
      "end": "text"
    },
    "tuesday": {
      "start": "text",
      "end": "text"
    },
    "wednesday": {
      "start": "text",
      "end": "text"
    },
    "thursday": {
      "start": "text",
      "end": "text"
    },
    "friday": {
      "start": "text",
      "end": "text"
    },
    "saturday": {
      "start": "text",
      "end": "text"
    },
    "sunday": {
      "start": "text",
      "end": "text"
    }
  },
  "is_active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_kind": "tms",
  "rule_kind": "clinic_open_hours",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_active": true,
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-05-12T12:17:02.096Z",
  "updated_at": "2026-05-12T12:17:02.096Z"
}

Get one scheduling rule set

get

Fetch one rule set by id. Returns 404 when the row doesn't exist in this workspace (the RLS policy means cross-workspace lookups surface as 404, never as a row from the wrong workspace).

Permissions: Workspace.view.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

rule_set_idstring · uuidRequired

Responses

200

Successful Response

application/json

Wire shape for a single rule set. params stays as dict here (not the discriminated union) so add-a-new-kind doesn't break older clients still on the previous SDK version — the SDK's typed helpers can re-validate into RuleParams when needed.

idstring · uuidRequired

workspace_idstring · uuidRequired

agent_kindstring · enumRequiredPossible values:

rule_kindstring · enumRequiredPossible values:

is_activebooleanRequired

created_byany ofRequired

string · uuidOptional

or

nullOptional

created_atany ofRequired

string · date-timeOptional

or

nullOptional

updated_atany ofRequired

string · date-timeOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

404

Rule set not found in this workspace.

422

Validation Error

application/json

429

Rate limited.

get

/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/scheduling-rule-sets/{rule_set_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_kind": "tms",
  "rule_kind": "clinic_open_hours",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_active": true,
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-05-12T12:17:02.096Z",
  "updated_at": "2026-05-12T12:17:02.096Z"
}

Delete a scheduling rule set

delete

Hard-delete. The audit log retains the deletion record.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

rule_set_idstring · uuidRequired

Responses

204

Successful Response

401

Missing or invalid API key.

403

Insufficient permissions.

404

Rule set not found in this workspace.

422

Validation Error

application/json

429

Rate limited.

delete

/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/scheduling-rule-sets/{rule_set_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Partially update a scheduling rule set

patch

Update params and/or is_active on an existing rule set. agent_kind and rule_kind are immutable — to change either, create a new rule set and delete the old one.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

rule_set_idstring · uuidRequired

Body

application/json

Partial update — fields not provided are unchanged. params must be the full per-kind shape (no patch within params); send the whole RuleParams or omit.

paramsany ofOptional

anyOptional

or

or

or

or

or

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Wire shape for a single rule set. params stays as dict here (not the discriminated union) so add-a-new-kind doesn't break older clients still on the previous SDK version — the SDK's typed helpers can re-validate into RuleParams when needed.

idstring · uuidRequired

workspace_idstring · uuidRequired

agent_kindstring · enumRequiredPossible values:

rule_kindstring · enumRequiredPossible values:

is_activebooleanRequired

created_byany ofRequired

string · uuidOptional

or

nullOptional

created_atany ofRequired

string · date-timeOptional

or

nullOptional

updated_atany ofRequired

string · date-timeOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

404

Rule set not found in this workspace.

422

Submitted params discriminator does not match the existing rule's rule_kind.

429

Rate limited.

patch

/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}

HTTPcURLJavaScriptPython

PATCH /v1/{workspace_id}/scheduling-rule-sets/{rule_set_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 360

{
  "params": {
    "rule_kind": "clinic_open_hours",
    "timezone": "text",
    "monday": {
      "start": "text",
      "end": "text"
    },
    "tuesday": {
      "start": "text",
      "end": "text"
    },
    "wednesday": {
      "start": "text",
      "end": "text"
    },
    "thursday": {
      "start": "text",
      "end": "text"
    },
    "friday": {
      "start": "text",
      "end": "text"
    },
    "saturday": {
      "start": "text",
      "end": "text"
    },
    "sunday": {
      "start": "text",
      "end": "text"
    }
  },
  "is_active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_kind": "tms",
  "rule_kind": "clinic_open_hours",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_active": true,
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-05-12T12:17:02.096Z",
  "updated_at": "2026-05-12T12:17:02.096Z"
}