agents.configure
Upsert per-tenant agent configuration. Owner-only. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
agentId | string | yes | |
enabled | boolean | no | |
schedule | string · nullable | no | |
requiresApproval | boolean | no | |
guardrails | object | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | no |
agents.list
List all registered agents with their per-tenant config (enabled, schedule, guardrails) and last run status.
Input parameters
Returns object.
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
agentId | string | yes | |
name | string | yes | |
description | string | yes | |
category | string | yes | |
enabled | boolean | yes | |
requiresApproval | boolean | yes | |
lastRunStatus | string · nullable | yes | |
lastRunAt | string · nullable | yes |
agents.proposals.list
List agent proposals awaiting human review. Defaults to pending proposals only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
agentId | string | no | |
status | array of enum | no | Default: ["pending"] |
limit | integer | no | Default: 50 |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
agentId | string | yes | |
proposalType | string | yes | |
payload | object | yes | |
status | string | yes | |
expiresAt | string · nullable | yes | |
createdAt | string | yes |
agents.proposals.review
Approve or reject an agent proposal. Approved proposals are logged; execution is handled by the application layer.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
decision | enum | yes | One of: approved, rejected |
note | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
status | string | yes |
agents.runs.list
Lists the runs of the property's AI agents (a log of every agent run), newest first, paginated (page, pageSize up to 100), optionally filtered to one agent (agentId). Requires the ai_agents module. Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
agentId | string | no | |
page | integer | no | Default: 1 |
pageSize | integer | no | Default: 25 |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
rows | array of object | yes | |
rows.id | string | yes | |
rows.tenantId | string | yes | |
rows.agentId | string | yes | |
rows.triggeredBy | enum | yes | One of: schedule, manual, event, orchestrator |
rows.status | enum | yes | One of: running, completed, failed, skipped |
rows.inputHash | string · nullable | yes | |
rows.outputSummary | string · nullable | yes | |
rows.durationMs | integer · nullable | yes | |
rows.tokensUsed | integer · nullable | yes | |
rows.error | string · nullable | yes | |
rows.createdAt | string | yes | |
rows.completedAt | string · nullable | yes | |
page | integer | yes | |
hasMore | boolean | yes |
agents.trigger
Manually trigger an agent run. The agent will run asynchronously; check agents.runs.list for status.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
agentId | enum | yes | One of: morning-routine, email-triage, email-processor, email-draft, booking-inquiry, arrival-time-check, concierge, pre-arrival-outreach, dynamic-pricing, room-upgrade, agent-notification, cleaning-schedule, fb-shopping-list, finance-filing, villa-analytics, marketing-report, crm-pipeline |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
jobId | string | yes |