Создайте процесс, который можно выполнить и проверить.

Возвращает человека или агента, которому принадлежит ключ, и его рабочее пространство.

Запрос

curl "$RECURIANT_API/me" \
  -H "Authorization: Bearer $RECURIANT_API_KEY"

Ответ, сокращённо

{
  "sub": "<id>",
  "email": "<email>",
  "username": "ana",
  "tenant": {
    "id": "<id>",
    "slug": "acme",
    "name": "acme"
  },
  "role": "",
  "principal_type": "user",
  "principal_id": "<id>"
}

Перечисляет рабочие процессы с триггером, условиями, шагами и признаком объявленной проверки результата.

Запрос

curl "$RECURIANT_API/workflows" \
  -H "Authorization: Bearer $RECURIANT_API_KEY"

Ответ, сокращённо

{
  "workflows": [
    {
      "name": "first-run",
      "on": "plane.label_added",
      "conditions": {
        "label": "first-run"
      },
      "steps": 2,
      "do": [
        {
          "action": "agent"
        },
        {
          "action": "plane.comment"
        }
      ],
      "has_verify": true
    }
  ],
  "defaults": {}
}

Перечисляет все действия, доступные вашему ключу, с входными данными, признаком изменения чего-либо за пределами Recuriant, обратимостью, влиянием и уровнем.

Запрос

curl "$RECURIANT_API/actions" \
  -H "Authorization: Bearer $RECURIANT_API_KEY"

Ответ, сокращённо

{
  "tenant": "acme",
  "actions": [
    {
      "name": "matrix.send",
      "kind": "connector",
      "mutates_external_state": true,
      "reversibility": "reversible",
      "impact": "low",
      "tier": "L1"
    }
  ],
  "total": 1
}

Выполняет действие по имени с настроенными проверками исполнения. Передайте аргументы действия в args. Вызов, продолжающийся в фоне, возвращает 202 с URL состояния в data.

Запрос

curl -X POST "$RECURIANT_API/actions/matrix.send" \
  -H "Authorization: Bearer $RECURIANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"args": {"body": "Deploy complete"}}'

Ответ, сокращённо

{
  "ok": true,
  "output": "<the action output>",
  "data": {}
}

Объясняет, какие процессы соответствуют примеру события и почему. Не отправляет задачи и не записывает решения политики. С параметром explain ответ также включает неподошедшие процессы.

Запрос

curl -X POST "$RECURIANT_API/dry-run" \
  -H "Authorization: Bearer $RECURIANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event": "plane.label_added", "vars": {"label": "first-run"}, "explain": true}'

Ответ, сокращённо

{
  "event": "plane.label_added",
  "vars": {
    "label": "first-run"
  },
  "matched_workflows": 1,
  "total_evaluated": 1,
  "matches": [
    {
      "workflow": "first-run",
      "matched": true
    }
  ],
  "results": [
    {
      "workflow": "first-run",
      "matched": true
    }
  ]
}

Перечисляет запуски. Фильтры: рабочий процесс, тип, статус или задача. В списке нет журналов шагов; полный журнал доступен при чтении одного запуска.

Запрос

curl "$RECURIANT_API/executions?workflow=first-run" \
  -H "Authorization: Bearer $RECURIANT_API_KEY"

Ответ, сокращённо

[
  {
    "id": "<id>",
    "type": "workflow",
    "status": "completed",
    "workflow_name": "first-run",
    "event_type": "plane.label_added",
    "started_at": "2026-11-02 09:10:04+00:00",
    "finished_at": "2026-11-02 09:12:41+00:00",
    "details_included": false,
    "step_log": null
  }
]

Возвращает один запуск с журналом шагов, запуском-родителем, текущим шагом и глубиной вложенности.

Запрос

curl "$RECURIANT_API/executions/<id>" \
  -H "Authorization: Bearer $RECURIANT_API_KEY"

Ответ, сокращённо

{
  "id": "<id>",
  "type": "workflow",
  "status": "completed",
  "workflow_name": "first-run",
  "parent_execution_id": null,
  "current_step": 2,
  "total_steps": 2,
  "depth": 0,
  "details_included": true
}