Apps API · Data types
Object types referenced by Apps API requests and responses.
AcceptDeliveredIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
source |
string: im, explicit, text_card_proxy |
yes | Acceptance source |
AcceptInvitationData
| Field | Type | Required | Description |
|---|---|---|---|
member_id |
string (uuid) | yes | Newly created member UUID |
org_id |
string (uuid) | yes | Organization joined |
role_slug |
string | yes | Assigned role slug |
AcceptInvitationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
token |
string | Invitation token (for token-based acceptance, e.g. agent invitations) |
AcceptIssuePlanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
expected_plan_token |
string | Optional current_plan_token of the plan the caller reviewed. Send it only to decide an issue in pending_plan, and only as the issue owner: with a token, a non-owner gets 403, a silent automation's or archived issue is refused, an issue not in pending_plan gets 412, and a plan that has changed since gets 412 WORK_ISSUE_PLAN_CHANGED; nothing is accepted in any of these cases. Omit to accept without the token rules; null is invalid | |
source |
string | Origin of the plan acceptance (e.g. explicit, text_card_proxy) |
AckSyncCommRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
app_version |
string | Client app version | |
device_id |
string | yes | Device ID |
platform |
string | Client platform | |
seq |
integer (int64) | yes | Highest processed sync sequence |
ActivateIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
source |
string: lead_chat, ui, event_binding, system |
Activation source. Defaults to ui (the human/UI action path) when omitted. |
AddMemberRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_id |
string (uuid) | yes | OrgMember/Participant UUID |
role |
string: UNSPECIFIED, MEMBER, ADMIN, OWNER, PUBLISHER, SUBSCRIBER |
Member role |
AddMessageReactionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reaction_code |
string | yes | Reaction code from the server-side reaction registry (e.g. thumbs_up, heart) |
AddProjectMemberRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_id |
string (uuid) | yes | Member UUID |
role |
string: member, lead |
yes | Project member role |
AddonHistoryDTO
| Field | Type | Required | Description |
|---|---|---|---|
addon_id |
string | yes | |
created_at |
string (date-time) | ||
ended_at |
string (date-time) | ||
identity_id |
string | ||
provision_spec |
AgentProvisionDTO |
||
retainer_points |
integer (int64) | yes | |
runtime_billing_enabled |
boolean | yes | |
runtime_rate |
AgentRuntimeRateDTO |
||
sku_code |
string | yes | |
status |
string | yes | |
tier |
string | yes | |
usage_points_day |
integer (int64) | yes |
AddonOutstandingDTO
| Field | Type | Required | Description |
|---|---|---|---|
addon_status |
string | yes | active|suspended|paused|pending_end|ended|… |
outstanding |
array of OutstandingItemDTO |
yes | Per-item debt breakdown (kind: arrears | restart_daily); empty when there is no debt |
total_outstanding_points |
integer (int64) | yes | Sum of outstanding[].points; 0 with an empty breakdown means there is no outstanding debt and the add-on can be resumed directly (resume charges nothing) |
AddonSummaryDTO
| Field | Type | Required | Description |
|---|---|---|---|
item_id |
string | yes | |
member_id |
string | Org member id of the platform_created agent this addon delivered; empty when the add-on has no platform-created agent | |
points_per_cycle |
integer (int64) | yes | |
runtime_billing_enabled |
boolean | yes | |
sku_code |
string | yes | |
status |
string | yes | |
tier |
string | yes |
AdminAgentStorageDTO
| Field | Type | Required | Description |
|---|---|---|---|
actual_observed_at |
string (date-time) | When the agent collected the actual_total_gb observation. | |
actual_total_gb |
number (double) | Observed mounted disk size in GiB (statfs total / 2^30, 2 decimals), slightly below total_gb because of filesystem overhead. Omitted when the agent has not reported disk metrics. | |
addon_gb |
integer (int32) | yes | |
addon_id |
string | yes | |
agent_identity_id |
string | yes | |
base_gb |
integer (int32) | yes | |
inflight_order |
AdminAgentStorageOrderDTO |
yes | |
max_total_gb |
integer (int32) | yes | |
micro_per_day |
integer (int64) | yes | |
org_id |
string | yes | |
tiers |
array of AdminAgentStorageTierDTO |
yes | |
total_gb |
integer (int32) | yes |
AdminAgentStorageOrderDTO
| Field | Type | Required | Description |
|---|---|---|---|
agent_identity_id |
string | yes | |
channel |
string | yes | self_service|admin |
completed_at |
string (date-time) | ||
created_at |
string (date-time) | ||
failure_reason |
string | ||
from_total_gb |
integer (int32) | yes | |
operator_id |
string | yes | |
order_id |
string | yes | |
org_id |
string | yes | |
size_gb |
integer (int32) | yes | |
slow |
boolean | yes | Resizing for longer than usual |
status |
string | yes | resizing|active|failed |
target_total_gb |
integer (int32) | yes | |
tier_code |
string | yes |
AdminAgentStorageTierDTO
| Field | Type | Required | Description |
|---|---|---|---|
micro_per_day |
integer (int64) | yes | Credits/day in micro-Credits (monthly / 30, not rounded) |
monthly_points |
integer (int64) | yes | |
size_gb |
integer (int32) | yes | |
tier_code |
string | yes | storage_10|storage_50|storage_100|storage_200 (storage_10 admin-only) |
AgentAvatarData
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | yes | Saved avatar URL; null when the default avatar is used |
member_id |
string (uuid) | yes | Agent member UUID |
AgentCapabilityTagsData
| Field | Type | Required | Description |
|---|---|---|---|
member_id |
string (uuid) | yes | Agent member UUID |
tags |
array of CapabilityTagDTO |
yes | The agent's capability tags after the write |
AgentChannelBindingItem
| Field | Type | Required | Description |
|---|---|---|---|
account_label |
string | yes | |
agent_member_id |
string | yes | |
channel_type |
string | yes | |
created_at |
string (date-time) | ||
id |
string | yes | |
last_error |
string | ||
last_reported_at |
string (date-time) | ||
qr_png_base64 |
string | ||
qr_updated_at |
string (date-time) | ||
request_id |
string | ||
runtime_status |
string | ||
source |
string | ||
status |
string | yes | |
updated_at |
string (date-time) |
AgentChannelCatalogItem
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
||
definition |
AgentChannelDefinitionItem |
yes |
AgentChannelDefinitionItem
| Field | Type | Required | Description |
|---|---|---|---|
category |
string | yes | |
channel_type |
string | yes | |
coming_soon |
boolean | yes | |
description_key |
string | yes | |
display_name |
string | yes | |
fields |
array of AgentChannelFormFieldItem |
yes | |
icon |
string | yes | |
labels |
object | yes |
AgentChannelFormFieldItem
| Field | Type | Required | Description |
|---|---|---|---|
field_type |
string | yes | |
key |
string | yes | |
labels |
object | yes | |
options |
array of string | ||
placeholder |
string | ||
readonly |
boolean | yes | |
required |
boolean | yes | |
sensitive |
boolean | yes | |
value |
string |
AgentCollabConversationItem
| Field | Type | Required | Description |
|---|---|---|---|
can_send |
boolean | yes | Always false for owner observation |
id |
string (uuid) | yes | Conversation UUID |
last_message_at |
string (date-time) | yes | Last message time |
last_message_id |
integer (int64) | Last message ID | |
last_message_preview |
LastMessagePreviewItem |
Last message preview | |
name |
string | Conversation name | |
participants |
array of AgentCollabParticipantItem |
yes | Conversation participants |
read_only_reason |
string: observer |
yes | Why this view is read-only |
shape |
string: agent_dm, agent_group |
yes | Agent collaboration shape |
type |
string | yes | Conversation type |
AgentCollabParticipantItem
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Member avatar URL | |
display_name |
string | yes | Member display name |
kind |
string: agent, system, human |
yes | Member kind |
member_id |
string (uuid) | yes | Member UUID |
status |
string: active, suspended, departed |
yes | Member status |
AgentCreditCapDTO
| Field | Type | Required | Description |
|---|---|---|---|
addon_id |
string | yes | |
agent_identity_id |
string (uuid) | yes | |
block_reason |
string: ``, daily, monthly, both |
yes | Which cap blocks the agent when blocked is true: daily, monthly or both; empty when not blocked. |
blocked |
boolean | yes | |
consumed_micro |
integer (int64) | yes | |
control_applied_revision |
integer (int64) | yes | |
daily_consumed_micro |
integer (int64) | yes | Counted consumption in the current Beijing-time (UTC+8) day, reported even without a daily cap. |
daily_effective_limit_micro |
integer (int64) | yes | daily_points in micro-points; 0 without a daily cap. |
daily_points |
integer (int64) | yes | Configured daily cap in points; 0 without a daily cap. |
day_end |
string (date-time) | Next daily reset (00:00 Beijing time (UTC+8)). | |
day_start |
string (date-time) | Start (00:00 Beijing time (UTC+8)) of the day that daily_consumed_micro covers. | |
effective_limit_micro |
integer (int64) | yes | |
has_daily_limit |
boolean | yes | True when a daily cap is configured; independent of has_limit (monthly). |
has_limit |
boolean | yes | |
monthly_points |
integer (int64) | yes | |
period_end |
string (date-time) | ||
period_start |
string (date-time) | ||
revision |
integer (int64) | yes | |
updated_at |
string (date-time) |
AgentDMEligibilityItem
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Agent member UUID, as requested |
can_dm |
boolean | yes | True only when status is allowed: the caller may start a DM with this agent |
status |
string: allowed, not_allowed, not_found, unknown |
yes | allowed: the caller owns the agent, or its DM policy lets the caller in. not_allowed: its DM policy does not let the caller in. not_found: not an agent, not active (suspended / departed), not in the caller's organization, removed, or unknown id (not distinguished). unknown: the agent's DM policy could not be read in time (failed or still pending at the server's read deadline); callers should treat unknown as not selectable. The policy itself is never returned. |
AgentGroupPolicyItem
| Field | Type | Required | Description |
|---|---|---|---|
allow_from |
array of string | yes | Member UUIDs allowed to trigger the agent |
conversation_id |
string (uuid) | yes | Conversation UUID |
mode |
string | yes | Group response mode |
AgentModelOption
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | |
key |
string | yes |
AgentModelResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentModelView |
yes | |
request_id |
string | yes | |
server_time |
string (date-time) | yes |
AgentModelView
| Field | Type | Required | Description |
|---|---|---|---|
apply_state |
string | ||
available_models |
array of AgentModelOption |
||
configurable |
boolean | yes | |
desired_model |
string | ||
desired_model_name |
string | ||
effective_model |
string | ||
effective_model_name |
string | ||
last_error |
string | ||
member_id |
string | yes | |
runtime |
string | ||
visible |
boolean | yes |
AgentOverviewItemDTO
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | ||
credit_cap |
AgentCreditCapDTO |
Monthly and daily credit caps and current counted consumption; omitted for external agents or when unavailable | |
display_name |
string | yes | |
estimated_monthly_points |
integer (int64) | retainer + usage_points_day×30 (billing-known agents only) | |
identity_id |
string (uuid) | yes | |
member_id |
string (uuid) | yes | |
provision_spec |
AgentProvisionDTO |
||
retainer_points_month |
integer (int64) | Monthly retainer points for agents on monthly-retainer billing; omitted for runtime-billed agents | |
runtime_billing_enabled |
boolean | yes | |
runtime_rate |
AgentRuntimeRateDTO |
||
source |
string: workspace_purchase, external |
yes | workspace_purchase = billed addon; external = not billed |
status |
string | yes | Member status (active/suspended/departed) |
tier |
string | standard|advanced (billing-known agents only) |
AgentOverviewListResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AgentOverviewItemDTO |
yes | Response payload |
pagination |
AgentOverviewPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
AgentOverviewPageMetadata
| Field | Type | Required | Description |
|---|---|---|---|
has_more |
boolean | yes | Whether another page exists |
page |
integer (int32) | yes | Page that produced this data (1-based); 1 when unpaged |
page_size |
integer (int32) | yes | Effective page size; 0 means unpaged (full roster returned) |
total |
integer (int64) | yes | Total items after q filtering, across all pages |
AgentProfile
| Field | Type | Required | Description |
|---|---|---|---|
billing_suspended |
boolean | True when the agent is stopped by billing enforcement (arrears); false otherwise, including a credit-cap stop (see credit_cap_reached). Omitted when unknown. Same rule as the member list. | |
credit_cap_reached |
boolean | True when the agent credit cap (daily or monthly) is the effective stop reason; omitted when not capped or unknown. Same rule as the member list. | |
display_name |
string | yes | Display name |
kind |
string: agent |
yes | Member type (always agent) |
member_id |
string (uuid) | yes | Agent member UUID |
online_status |
string: online, offline, unknown |
Online status (unknown if it cannot be determined) | |
skills |
array of SkillDTO |
Skills the agent self-reports (objective dimension; present only when include=capabilities) | |
status |
string: active, suspended, departed |
yes | Member status |
tags |
array of CapabilityTagDTO |
Human-declared capability tags (subjective dimension; present only when include=capabilities) |
AgentProvisionDTO
| Field | Type | Required | Description |
|---|---|---|---|
limit_cpu |
string | ||
limit_memory |
string | ||
request_cpu |
string | ||
request_memory |
string | ||
storage |
string |
AgentRuntimeCommandResult
| Field | Type | Required | Description |
|---|---|---|---|
accepted_at |
string (date-time) | When agent-manager accepted the command (if returned) | |
command |
string: restart, interrupt, pause, resume, resources |
yes | Runtime command issued |
member_id |
string (uuid) | yes | Agent member UUID the command targeted |
operation_id |
string | Agent-manager operation ID for tracing the command (if returned) |
AgentRuntimeMetricsData
| Field | Type | Required | Description |
|---|---|---|---|
cost |
RuntimeMetricsCost |
yes | Usage cost metrics |
member_id |
string (uuid) | yes | Agent member UUID |
rate_limit_pct |
number (double) | Rate limit usage percentage (5h window) | |
reported_at |
string (date-time) | When the agent last reported metrics | |
resources |
RuntimeMetricsResources |
yes | System resource metrics |
runtime |
RuntimeMetricsRuntime |
yes | Runtime state and model info |
version |
string | Reporting agent's own version, e.g. 2.7.5 |
AgentRuntimeRateDTO
| Field | Type | Required | Description |
|---|---|---|---|
effective_from |
string (date-time) | ||
online_points_micro_per_minute |
integer (int64) | yes | |
sleep_points_micro_per_minute |
integer (int64) | yes | |
version |
integer (int64) | yes |
AnalyticsCard
| Field | Type | Required | Description |
|---|---|---|---|
total |
integer (int64) | yes | Current cumulative total |
trend7d |
array of integer (int64) | yes | Per-day cumulative total over the last 7 days (oldest first) |
wow_pct |
number (double) | yes | Week-over-week change percent vs one week ago; null when the count one week ago was 0, because percent change from zero is undefined (a client must not render it as 0%) |
AnalyticsCards
| Field | Type | Required | Description |
|---|---|---|---|
agents |
AnalyticsCard |
yes | |
humans |
AnalyticsCard |
yes | |
issues |
AnalyticsCard |
yes | |
projects |
AnalyticsCard |
yes |
AnalyticsOverview
| Field | Type | Required | Description |
|---|---|---|---|
cards |
AnalyticsCards |
yes |
AppAgentGrantItem
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | The Agent the app may act as |
app_id |
string (uuid) | yes | The app |
created_at |
string (date-time) | yes | When the owner granted it |
granted_by_member_id |
string (uuid) | yes | The Agent's owner who granted it |
id |
string (uuid) | yes | Grant ID |
installation_id |
string (uuid) | yes | The app installation the grant belongs to |
revoke_reason |
string: revoked_by_owner, revoked_by_admin, owner_changed, agent_left, app_uninstalled, app_suspended |
yes | Why it is revoked; null while active |
revoked_at |
string (date-time) | yes | When it was revoked; null while active or when revoked only in effect |
status |
string: active, revoked |
yes | Effective status, derived from the live state: a grant whose Agent left, whose owner changed or whose installation is no longer active reads as revoked immediately, before the revocation is recorded |
AppAgentGrantResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AppAgentGrantItem |
yes | The grant |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
AppOAuthError
| Field | Type | Required | Description |
|---|---|---|---|
error |
string: invalid_request, invalid_client, invalid_grant, invalid_scope, unsupported_grant_type, unsupported_token_type |
yes | OAuth error code (RFC 6749 §5.2): invalid_client with 401, any other with 400. unsupported_token_type only on revocation (RFC 7009); invalid_grant, invalid_scope and unsupported_grant_type only on the token endpoint |
error_description |
string | Human-readable error detail |
AppTokenBody
| Field | Type | Required | Description |
|---|---|---|---|
access_token |
string | App access token (JWT, 15 minutes) | |
error |
string | OAuth error code (RFC 6749 §5.2) | |
error_description |
string | Human-readable error detail | |
expires_in |
integer (int64) | Access token lifetime in seconds (900) | |
id_token |
string | OpenID Connect id_token (verify with get-app-jwks) | |
refresh_token |
string | Refresh token; only for grants carrying offline_access | |
scope |
string | Granted scopes, space-delimited | |
token_type |
string | Bearer | |
user |
AppTokenUser |
The member the token acts as |
AppTokenUser
| Field | Type | Required | Description |
|---|---|---|---|
email |
string | Login email; in this token response (and the id_token email claim) only when the grant carries org:me.email:read. That scope governs only these two places: GET /api/v1/me, granted by the implicit org:me:read, returns the login email regardless | |
member_id |
string (uuid) | yes | The member ID; the stable user identifier the app binds its account to |
name |
string | yes | Display name |
org_id |
string (uuid) | yes | The member's organization |
org_role |
string: owner, admin, member |
yes | Organization role, for the app's reference only (the platform never authorizes on it) |
ApprovalItem
| Field | Type | Required | Description |
|---|---|---|---|
action |
string | Requested action | |
approver_member_id |
string (uuid) | Approver member UUID | |
auto_approved |
boolean | yes | Whether the request was auto-approved |
cancel_reason |
string | Cancellation reason | |
created_at |
string (date-time) | yes | Creation time |
decided_at |
string (date-time) | Decision time | |
decided_by_member_id |
string (uuid) | Decision actor member UUID | |
decision_reason |
string | Decision reason | |
detail |
any | Approval request detail | |
expired_reason |
string | Expiry reason | |
granted_effect |
any | Persisted authorization effect metadata | |
id |
string (uuid) | yes | Approval request UUID |
kind |
string: resource_grant, external_share, app_publish, app_install |
yes | Approval request kind (app_publish / app_install are created by the Apps API) |
org_id |
string (uuid) | yes | Organization UUID |
policy_id |
string (uuid) | Approval policy UUID | |
request_expires_at |
string (date-time) | Request expiry time | |
request_reason |
string | Request reason | |
requester_member_id |
string (uuid) | yes | Requester member UUID |
scope_id |
string (uuid) | yes | Scope/resource UUID |
scope_type |
string | yes | Scope/resource type |
status |
string: pending, approved, rejected, cancelled, expired |
yes | Approval status |
updated_at |
string (date-time) | yes | Last update time |
AttachmentItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | yes | Artifact UUID |
content_type |
string | yes | Content type |
file_name |
string | yes | File name |
size_bytes |
integer (int64) | yes | File size in bytes |
AttemptItem
| Field | Type | Required | Description |
|---|---|---|---|
assignee_id |
string (uuid) | yes | Assignee member UUID |
attempt_number |
integer (int32) | yes | Attempt number |
blocked_at |
string (date-time) | Blocked time | |
blocked_on_approval_request_ids |
array of string (uuid) | Blocked approval request UUIDs | |
created_at |
string (date-time) | yes | Creation time |
execution_trace_id |
string | Execution trace ID | |
failure_reason |
string | Failure reason | |
finished_at |
string (date-time) | Finish time | |
id |
string (uuid) | yes | Attempt UUID |
started_at |
string (date-time) | Start time | |
status |
string: running, done, failed, blocked, cancelled |
yes | Attempt status |
task_id |
string (uuid) | yes | Task UUID |
updated_at |
string (date-time) | yes | Last update time |
AuthorizeConnectAgentRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
actor_member_id |
string | Optional acting member UUID. The actor is always the authenticated caller: if provided it must equal the caller's member UUID (case-insensitive), otherwise the request is rejected with 403 AUTH_FORBIDDEN. Omit to use the caller. | |
agent_member_id |
string (uuid) | yes | Agent member UUID |
confirm |
boolean | Set true to authorize an agent whose runtime version is unknown (acknowledges the CONNECT_AGENT_VERSION_UNCONFIRMED prompt). Ignored for agents whose version is known — a too-old version is always rejected. |
AutoTopupSettingsDTO
| Field | Type | Required | Description |
|---|---|---|---|
card_brand |
string | yes | Display card brand of the pinned credential (e.g. visa); together with card_last4 it forms a line such as "VISA ···· 4242". May be empty: Alipay has no card brand, and a revoked credential can no longer be read. When empty, show only payment_method_type instead of an empty card number |
card_last4 |
string | yes | Last four digits of the pinned credential. May be empty; handle it like an empty card_brand |
configured |
boolean | yes | Whether auto top-up has ever been configured. false: never configured, and the fields above are meaningless. Once true, the fields above keep the user's last saved values even after auto top-up is turned off (enabled=false) |
credential_id |
string | yes | ID of the payment credential pinned when auto top-up was enabled; it decides which payment method is charged. Meaningless when configured=false |
enabled |
boolean | yes | Whether auto top-up is turned on. While it is off the other fields keep the last saved configuration, so a client can show it again; turning it off does not erase it |
feature_enabled |
boolean | yes | Whether this deployment offers auto top-up (a global feature flag, off by default). When false, hide the whole section rather than showing a switch that cannot be changed; an existing configuration is still returned while the flag is off |
month_used_points |
integer (int64) | yes | Credits auto top-up has added this month, shown with monthly_cap_points as "X / Y this month". Counts only successful top-ups; the month boundary is UTC (the same boundary the monthly cap is checked against; showing it in a local time zone would be off by a few hours, so the page could say a top-up is still possible while the charge is refused for exceeding the cap). It is usage, not configuration, so it does not depend on configured. Only GET carries the real value; the PUT response always has 0, so refetch after a successful write |
monthly_cap_points |
integer (int64) | yes | Cap on the credits auto top-up may add in one calendar month. At least 1: a cap of 0 would be an enabled setting that never tops up. Meaningless when configured=false |
paused |
boolean | yes | Whether auto top-up is currently paused: the last top-up ran through all its retries and still failed, so no further charge is attempted however low the balance gets. enabled stays true (the user did not turn it off; the system stopped), so render the two fields separately. Either of two things resumes it: the balance rising back above the threshold through a credited payment (a manual credit-pack purchase, a payment callback credit, or a support adjustment; refunds and reversals raise the balance but do NOT resume it), or the user saving an enabled configuration again. User-facing text must mention both ways. It is state the user cannot change, not configuration, so it does not depend on configured. Only GET carries the real value; the PUT response is always false |
paused_reason |
string | yes | Why auto top-up is paused: the raw failure code of the final failed attempt. It is a code, not display text: map it to your own localized message and never show it to users as is. May be empty even when paused=true, so have a generic fallback message (such as "the last top-up failed"). Never read an empty reason as not paused: only paused says whether it is paused. The PUT response always has an empty string |
payment_method_type |
string | yes | Method type of the pinned credential: card or alipay. wechat does not support off-session charges and is refused when configuring. Meaningless when configured=false |
sku_code |
string | yes | The credit-pack SKU bought when a top-up triggers. Meaningless when configured=false |
threshold_points |
integer (int64) | yes | A top-up is triggered when the balance drops strictly below this value. At least 1: under a strict less-than check 0 would never trigger (the balance is never negative); use 1 for "top up only when the balance reaches zero". Meaningless when configured=false |
AutomationArtifactItem
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes | |
url |
string | yes |
AutomationAuthorizationPlan
| Field | Type | Required | Description |
|---|---|---|---|
configuration |
AutomationCreationConfiguration |
yes | |
expected_version |
integer (int64) | ||
operation |
string: create, update |
yes | |
source_kind |
string: timer, webhook |
yes | |
target_binding_id |
string (uuid) |
AutomationAuthorizationPreview
| Field | Type | Required | Description |
|---|---|---|---|
proposal_text |
string | yes |
AutomationCreationConfiguration
| Field | Type | Required | Description |
|---|---|---|---|
anchor_at |
string (date-time) | ||
cron_expr |
string | ||
event_filter |
string | ||
interval_seconds |
integer (int64) | ||
lead_member_id |
string (uuid) | yes | |
owner_member_id |
string (uuid) | yes | |
project_member_additions |
array of string | Members added to spec.project_id together with the confirmed write: only lead_member_id and/or owner_member_id, each once, lead first. Omitted or empty when both are already members; always empty for the Inbox | |
result_notification_policy |
string: every, failure_only, none |
Result DM policy; omitted creates use source default, omitted updates preserve the existing policy and migration notice. HTTP null is tolerated as omission | |
run_at |
string (date-time) | ||
schedule_kind |
string: cron, once, interval |
||
spec |
AutomationCreationSpec |
yes | |
timezone |
string |
AutomationCreationEligibility
| Field | Type | Required | Description |
|---|---|---|---|
checked_at |
string (date-time) | yes | |
current_version |
string | ||
member_id |
string | yes | |
minimum_version |
string | ||
reason |
string | yes | |
reported_at |
string (date-time) | ||
status |
string | yes |
AutomationCreationPayload
| Field | Type | Required | Description |
|---|---|---|---|
configuration |
AutomationCreationConfiguration |
yes | |
form_context |
object | yes | |
kind |
string: automation-create-request |
yes | |
lead_member_id |
string (uuid) | yes | |
org_id |
string (uuid) | yes | |
request_id |
string (uuid) | yes | |
requester_member_id |
string (uuid) | yes | |
schema_version |
integer (int64) | yes | |
source_kind |
string: timer, webhook |
yes |
AutomationCreationSpec
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | ||
knowledge_base_id |
string (uuid) | Knowledge base of the runs; required exactly for knowledge_base_mode custom | |
knowledge_base_mode |
string: project_default, custom, none |
Where runs store their outputs: the project's knowledge base, knowledge_base_id, or none. Omitted: project_default on a create; an update keeps the current choice | |
project_id |
string (uuid) | Project the run Issues belong to; required unless unattached. An unattached automation may name the system project an earlier read returned | |
title |
string | yes | |
unattached |
boolean | The automation belongs to no project: it runs in the organization Inbox or, for a private one, in the Owner's hidden private project. Omitted: attached on a create; an update keeps the current attachment | |
unattached_scope |
string: org, private |
With unattached and no project_id: org (default) or private |
AutomationDeliveryItem
| Field | Type | Required | Description |
|---|---|---|---|
artifacts |
array of AutomationArtifactItem |
yes | |
conversation_id |
string | ||
id |
string | yes | |
message_id |
string | ||
notification_status |
string: pending, sent, suppressed |
yes | suppressed means this result is retained but its run policy intentionally prevents a DM; it is not a retryable delivery failure |
outcome |
string: success, partial, failed |
yes | |
summary |
string | yes |
AutomationHandoffRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
intro |
string | yes | |
request |
AutomationCreationPayload |
yes |
AutomationHandoffResult
| Field | Type | Required | Description |
|---|---|---|---|
conversation_id |
string | yes | |
message_id |
string | yes | |
request_id |
string | yes |
AutomationProposalRequest
| Field | Type | Required | Description |
|---|---|---|---|
configuration |
AutomationCreationConfiguration |
yes | |
expected_version |
integer (int64) | ||
operation |
string: create, update |
yes | |
replaces_proposal_message_id |
string | ||
request_id |
string (uuid) | yes | |
requester_member_id |
string (uuid) | ||
source_kind |
string: timer, webhook |
yes | |
target_binding_id |
string (uuid) |
AutomationProposalResponse
| Field | Type | Required | Description |
|---|---|---|---|
authorization_kind |
string | yes | |
cancel_action_id |
string | yes | |
confirm_action_id |
string | yes | |
conversation_id |
string | yes | |
modify_action_id |
string | yes | |
proposal_message_id |
string | yes | |
proposal_text |
string | yes |
AutomationProposalStatus
| Field | Type | Required | Description |
|---|---|---|---|
authorization_kind |
string | yes | |
card_interaction_id |
string | ||
expires_at |
string (date-time) | yes | |
proposal_message_id |
string | yes | |
status |
string | yes |
AutomationUpdateHandoffRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
intro |
string | yes | |
request |
AutomationUpdatePayload |
yes |
AutomationUpdatePayload
| Field | Type | Required | Description |
|---|---|---|---|
configuration |
AutomationCreationConfiguration |
yes | |
expected_version |
integer (int64) | yes | |
form_context |
object | yes | |
kind |
string: automation-update-request |
yes | |
lead_member_id |
string (uuid) | yes | |
org_id |
string (uuid) | yes | |
request_id |
string (uuid) | yes | |
requester_member_id |
string (uuid) | yes | |
schema_version |
integer (int64) | yes | |
source_kind |
string: timer, webhook |
yes | |
target_binding_id |
string (uuid) | yes |
AvatarUploadFinalized
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string (uuid) | yes | Active avatar artifact UUID |
avatar_url |
string | yes | Long-lived avatar URL to save as avatar_url (PATCH /api/v1/me or PUT /api/v1/agents/{member_id}/avatar) |
AvatarUploadPrepared
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string (uuid) | yes | Avatar artifact UUID |
expires_at |
string (date-time) | yes | Presigned PUT expiration time |
headers |
object | yes | Headers required on the presigned PUT |
session_id |
string (uuid) | yes | Upload-session UUID |
upload_url |
string | yes | Presigned PUT URL for the image bytes |
BalanceAlertSettingsDTO
| Field | Type | Required | Description |
|---|---|---|---|
has_threshold |
boolean | yes | false: no absolute threshold has been set; only the burn-rate based 7 / 3 / 1-day warnings apply |
low_balance_points |
integer (int64) | yes | Alert when the balance drops to this many credits or fewer. Meaningless when has_threshold=false |
BatchAddConversationMembersRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_ids |
array of string | yes | OrgMember/Participant UUIDs to add |
role |
string: UNSPECIFIED, MEMBER, ADMIN, OWNER, PUBLISHER, SUBSCRIBER |
Role applied to every added member |
BatchAgentDMEligibilityRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_ids |
array of string | yes | Agent member UUIDs to check, at most 100. Every id must be a well-formed UUID (otherwise the whole batch is rejected with 422). Duplicates are collapsed; [] returns no items. |
BatchAgentDMEligibilityResult
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of AgentDMEligibilityItem |
yes | One item per distinct requested id, in the order of first appearance in the request |
BatchAuthorizeConnectAgentsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
actor_member_id |
string | Optional acting member UUID. The actor is always the authenticated caller: if provided it must equal the caller's member UUID (case-insensitive), otherwise the request is rejected with 403 AUTH_FORBIDDEN. Omit to use the caller. | |
agent_member_ids |
array of string (uuid) | yes | Agent member UUIDs to authorize, 1..50 as sent. Duplicates are collapsed (first occurrence keeps its position). An empty list, more than 50 ids or a malformed UUID rejects the whole request with 400. |
confirm |
boolean | Set true to authorize agents whose runtime version is unknown (acknowledges CONNECT_AGENT_VERSION_UNCONFIRMED). Applies to every agent of the request; resubmit only the unconfirmed agents with it. A too-old version is always rejected. |
BatchGetFileDownloadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
inline |
boolean | yes | Request inline content disposition |
node_ids |
array of string | yes | Tree node UUIDs |
BatchGetMessagesRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
message_ids |
array of string | yes | IDs of messages in this conversation to fetch, at most 100 (message ids are int64, carried as decimal strings) |
BatchGetMessagesResult
| Field | Type | Required | Description |
|---|---|---|---|
deferred_ids |
array of string | yes | Requested ids not returned because of the per-response card cap; ask for them again |
head_change_seq |
integer (int64) | yes | The conversation's change-log head as of these items |
items |
array of MessageItem |
yes | Current version of the found messages, ascending by seq, with the same enrichment and card trimming as list-messages; a recalled message comes back as its tombstone |
missing_ids |
array of string | yes | Requested ids that were silently deleted, hard deleted, or are not in this conversation |
BatchMemberDisplayInfoRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_ids |
array of string | yes | Member UUIDs to resolve. Every id must be a well-formed UUID (otherwise the whole batch is rejected with 422). Well-formed ids outside the caller's organization, or never known, are omitted from the result rather than failing the batch. |
BatchMemberDisplayInfoResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
members |
array of MemberDisplayInfo |
yes | Resolved members, in no particular order. Missing ids were not found in the caller's organization. |
request_id |
string | yes | |
server_time |
string (date-time) | yes |
BatchRemoveConversationMembersRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_ids |
array of string | yes | OrgMember/Participant UUIDs to remove |
BatchRemoveMembersRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
member_ids |
array of string | yes | Member UUIDs to remove |
BatchRemoveMembersResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
results |
array of MemberBatchResult |
yes | Outcome per executed member, in request order; blank and duplicate ids are not represented here |
summary |
MemberBatchSummary |
yes | Batch outcome counts |
BillingCapabilitiesData
| Field | Type | Required | Description |
|---|---|---|---|
auto_renew_disabled |
boolean | yes | true ⇒ this deployment never auto-renews a subscription: no recurring charge is attempted at period end, and clients must not present auto-renew as on, nor offer to turn it on. false or absent ⇒ international behaviour (subscriptions auto-renew). It is also enforced server-side: the payment method is downgraded to a non-recurring tier, every write of a subscription's auto_renew is forced off, and no renewal charge is attempted. |
auto_topup_disabled |
boolean | yes | true ⇒ automatic credit top-up is not offered: hide the whole auto top-up section. false or absent ⇒ international behaviour (the section is shown unless the setting below hides it). Hide the auto top-up section when this bit is true OR when feature_enabled from GET /api/v1/billing/auto-topup-settings is false; never rely on only one of the two. |
balance_alerts_locked |
boolean | yes | true ⇒ balance alert thresholds are fixed by the deployment: render them read-only rather than as editable settings. false or absent ⇒ international behaviour (user-editable alerts). NOT display-only: billing refuses writes to the alert threshold while this bit is true (reads stay open). The China-edition value is false since 2026-09-16. |
card_payment_disabled |
boolean | yes | true ⇒ credit-card payment is not offered; a card payment_method is refused server-side. false or absent ⇒ international behaviour (card offered). Unlike most bits here this one is also enforced by the server (a card payment method is refused when it is classified, set up or saved), so it is a guarantee and not only a request to the client. Do not treat a 401/404 on this endpoint as license to offer card. |
checkout_result_binary |
boolean | yes | true ⇒ render the checkout outcome as two states only (succeeded / failed), collapsing every intermediate 'processing/pending' presentation into failed-and-retryable. false or absent ⇒ international behaviour (the full multi-state outcome, including pending). |
credit_pack_metered |
boolean | yes | true ⇒ credit packs are sold as a metered quantity (choose an amount at a fixed unit price) instead of fixed-size SKUs. false or absent ⇒ international behaviour (fixed SKUs). It is also enforced server-side (credit-pack quote and submit, and the idempotency fingerprint). |
enterprise_contact_sales_only |
boolean | yes | true ⇒ the enterprise tier is contact-sales only: show a contact card instead of a purchasable price, and never route it into checkout. false or absent ⇒ international behaviour (enterprise handled like the other tiers). The China-edition value is provisional and may change. |
installment_view_enabled |
boolean | yes | true ⇒ show the per-instalment / grant-schedule view of a multi-period purchase. false or absent ⇒ international behaviour (no instalment view). Additive bit. The schedule data this view renders is not available yet, so a client that turns the view on has nothing to show. |
invoice_entry_enabled |
boolean | yes | true ⇒ show the invoice request entry. false or absent ⇒ international behaviour (no invoice entry). Additive bit; a client should not enable the entry before the invoice flow it points at exists. |
plan_change_disabled |
boolean | yes | true ⇒ mid-cycle plan change (upgrade/downgrade with proration) is not offered: clients hide the change-plan entry and the proration quote. false or absent ⇒ international behaviour (plan change offered). It is also refused server-side, on both the quote and the submit path. |
plan_status_badge_expiry_states |
boolean | yes | true ⇒ the plan status badge uses the expiry-oriented state set (expiring soon / expired) that only makes sense when renewal is manual. false or absent ⇒ international behaviour (the auto-renew-oriented state set). Display-only. |
refund_disabled |
boolean | yes | true ⇒ no self-service refund surface: clients hide any refund entry and any copy promising one. false or absent ⇒ international behaviour. Enforced today by the refund route not existing at all; this bit exists so a client does not have to infer that from a 404. |
renewal_entry_enabled |
boolean | yes | true ⇒ show the MANUAL renewal entry (the China edition needs it precisely because auto_renew_disabled is also true, so renewal has to be a user action). false or absent ⇒ international behaviour: no manual renewal entry, renewal happens automatically. Additive bit — false is the international default, not a disabled feature. |
terms_acceptance_required |
boolean | yes | true ⇒ the client must obtain explicit terms acceptance before submitting a purchase. false or absent ⇒ international behaviour (no separate acceptance step). ⚠ There is NO server-side gate behind this bit: nothing persists an accepted terms version, so a client can bypass it by removing a disabled attribute. Treat it as a UI requirement, not as compliance evidence. |
upgrade_badge_hidden |
boolean | yes | true ⇒ suppress the promotional upgrade badge/nudge on plan cards. false or absent ⇒ international behaviour (badge shown). Display-only. |
BillingPageListResponseAddonHistoryDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AddonHistoryDTO |
yes | Response payload |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
BillingPageListResponseCreditGrantDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of CreditGrantDTO |
yes | Response payload |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
BillingPageListResponseInvoiceApplicationDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of InvoiceApplicationDTO |
yes | Response payload |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
BillingPageMetadata
| Field | Type | Required | Description |
|---|---|---|---|
has_more |
boolean | yes | Whether another page exists; fetch it by incrementing page with the same page_size |
page |
integer (int32) | yes | Page number that produced this data (1-based) |
page_size |
integer (int32) | yes | Effective page size (server default 50 when omitted) |
BillingPaymentOptionDTO
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | yes | Whether this method may be offered and submitted for this scenario; disabled entries are returned so clients can distinguish 'withheld' from 'unknown' |
id |
string | yes | Payment method wire value, submitted as payment_method (card|wechat|alipay) |
sort |
integer (int64) | yes | Display order, ascending |
BillingPaymentOptionsData
| Field | Type | Required | Description |
|---|---|---|---|
options |
array of BillingPaymentOptionDTO |
yes | Configured payment methods for this scenario, ordered by sort |
scenario |
string | yes | Echo of the requested scenario |
BindAgentChannelRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
config |
object | yes | Channel form values keyed by field key. Sensitive values are forwarded to the agent runtime and are never persisted or logged by the platform. |
BlueprintItem
| Field | Type | Required | Description |
|---|---|---|---|
approval_request_id |
string (uuid) | Approval request UUID | |
approved_at |
string (date-time) | Approval time | |
author_agent_id |
string (uuid) | yes | Author agent UUID |
content_hash |
string | yes | Blueprint content hash |
created_at |
string (date-time) | yes | Creation time |
estimated_budget |
object | Estimated budget JSON object | |
id |
string (uuid) | yes | Blueprint UUID |
issue_id |
string (uuid) | yes | Issue UUID |
notes |
string | yes | Blueprint notes |
status |
string: draft, approved, rejected, superseded |
yes | Blueprint status |
steps |
array of BlueprintStepItem |
Blueprint steps | |
superseded_at |
string (date-time) | Superseded time | |
updated_at |
string (date-time) | yes | Last update time |
version_number |
integer (int32) | yes | Blueprint version number |
BlueprintStepItem
| Field | Type | Required | Description |
|---|---|---|---|
blueprint_id |
string (uuid) | yes | Blueprint UUID |
created_at |
string (date-time) | yes | Creation time |
depends_on |
array of string | Dependency step UUIDs | |
description |
string | yes | Step description |
id |
string (uuid) | yes | Blueprint step UUID |
required_resources |
object | Required resources JSON object | |
sort_order |
integer (int32) | yes | Step sort order |
updated_at |
string (date-time) | yes | Last update time |
BridgeDetailItem
| Field | Type | Required | Description |
|---|---|---|---|
last_sync_at |
string (date-time) | yes | Last sync time |
platform |
string | yes | Bridge platform |
status |
string | yes | Bridge status |
BroadcastDetailItem
| Field | Type | Required | Description |
|---|---|---|---|
publisher_count |
integer (int32) | yes | Publisher count |
subscriber_count |
integer (int32) | yes | Subscriber count |
CancelApprovalRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Cancellation reason |
CapabilityTagDTO
| Field | Type | Required | Description |
|---|---|---|---|
kind |
string: curated, freeform |
yes | curated = controlled vocabulary key (hard filter, i18n via key); freeform = free text (soft ranking only, not translated) |
note |
string | Optional free-text nuance | |
tag |
string | yes | For curated: a stable, language-independent vocabulary key (see the published capability-tag vocabulary; the client localizes the key for display). For freeform: free text. |
CapabilityTagInputDTO
| Field | Type | Required | Description |
|---|---|---|---|
kind |
string: curated, freeform |
yes | curated = controlled vocabulary key (hard filter, i18n via key); freeform = free text (soft ranking only, not translated) |
note |
string | Optional free-text nuance | |
tag |
string | yes | For curated: a stable vocabulary key from the published capability-tag vocabulary (rejected with MEMBER_CAPABILITY_TAG_INVALID if unknown). For freeform: free text. |
CapabilityTagVocabularyData
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of CapabilityTagVocabularyItemDTO |
yes | Ordered curated capability-tag options |
CapabilityTagVocabularyItemDTO
| Field | Type | Required | Description |
|---|---|---|---|
deprecated |
boolean | Whether this option should be hidden for new selections | |
key |
string | yes | Stable language-independent curated capability-tag key submitted in API payloads |
labels |
object | Localized display labels keyed by locale, for example zh or en |
CardActionSubmitInput
| Field | Type | Required | Description |
|---|---|---|---|
action_id |
string | yes | Card-local id of the clicked action; must be a kind=operation action |
CardChoiceResult
| Field | Type | Required | Description |
|---|---|---|---|
card_sender |
CardIdentityItem |
Sender of the card that was answered | |
change_seq |
integer (int64) | yes | Conversation change_seq the settlement allocated, so the acting device can advance its change watermark. 0 on a replay, which records nothing new. |
interaction_id |
string | yes | Interaction record ID |
replayed |
boolean | yes | True when this card had already been answered and this request did not change it. The first answer stands; this is not an error — selected_action_ids carries the answer that won. |
result_at |
string (date-time) | yes | When the settled answer was recorded. On a replay this is the first answer's instant, not this request's. |
selected_action_ids |
array of string | Card-local ids of the options that were SETTLED, read back from the stored answer. On a replay these are the winning first answer, NOT the ids sent in this request. | |
status |
string | yes | Always succeeded: a record exists only for an answer that was accepted |
CardChoiceSubmitInput
| Field | Type | Required | Description |
|---|---|---|---|
selected_action_ids |
array of string | yes | Card-local ids of the chosen options. For selection_mode=single this is exactly one id. |
selection_mode |
string | yes | How many options the card accepts. The protocol reserves 'multiple'; the platform serves only 'single' today and fails closed on anything else. |
CardFormAnswerInput
| Field | Type | Required | Description |
|---|---|---|---|
other_text |
string | Present, even as an empty string, when the other choice is ticked; absent when it is not. A blank one ticks other without counting the question as answered. | |
selected_option_ids |
array of string | Choice questions only: option ids of this question that were chosen. On a single question the options and other together take exactly one choice, so with other ticked this is empty. | |
text |
string | Text questions only: the typed answer. The platform trims it; blank counts as not answered. Nothing is truncated: too long or too short is refused. |
CardFormAnswerItem
| Field | Type | Required | Description |
|---|---|---|---|
other_text |
string | Present when the other choice was ticked, as an empty string when it was ticked with no details; absent when it was not ticked | |
selected_option_ids |
array of string | yes | Option ids from the card, in the card's order |
text |
string | Answer to a text question as the platform stored it (trimmed); absent on a choice question |
CardFormSubmitInput
| Field | Type | Required | Description |
|---|---|---|---|
answers |
object | yes | Answers keyed by question key, holding only the questions the answerer chose something on |
CardIdentityItem
| Field | Type | Required | Description |
|---|---|---|---|
kind |
string | yes | human_member | agent_member | system_member |
member_id |
string | yes | Member UUID |
CardInteractionAuditItem
| Field | Type | Required | Description |
|---|---|---|---|
action_id |
string | yes | Card-local id of the clicked action |
actor_id |
string (uuid) | yes | Member UUID that clicked |
actor_type |
string | yes | Always human: the recorded actor is the person who clicked |
confirmed_at |
string (date-time) | yes | When the platform persisted the record |
content_version |
integer (int32) | yes | The card's content version at resolve time, frozen so the record still proves what was clicked after a recall purges the body |
correlation_id |
string | Opaque key the caller supplied at click time; absent when none was sent | |
form_answers |
object | Submitted answer of a form-card interaction, keyed by question key; absent on every other interaction | |
interaction_id |
string | yes | Interaction record ID |
operation |
string | yes | Registry operation the click dispatched to |
result_at |
string (date-time) | yes | When the business took effect, read out of the business response |
status |
string | yes | Always succeeded: a failed business call records no interaction |
CardInteractionResult
| Field | Type | Required | Description |
|---|---|---|---|
action_id |
string | yes | Card-local action id that was clicked |
card_sender |
CardIdentityItem |
Sender of the card the action belongs to | |
change_seq |
integer (int64) | yes | Conversation change_seq the settlement allocated, so the acting device can advance its change watermark. 0 on a replay, which records nothing new. |
interaction_id |
string | yes | Interaction record ID |
replayed |
boolean | yes | True when the same idempotency key already had an interaction record |
result_at |
string (date-time) | yes | When the business took effect, read out of the business response |
status |
string | yes | Always succeeded: a record exists only for an effect that happened |
CardInteractionSubmitResult
| Field | Type | Required | Description |
|---|---|---|---|
action_id |
string | Action only: the card-local action id that was clicked | |
actor_id |
string (uuid) | Form only: the member who submitted the stored answer. On a replay this tells the caller's own earlier submit apart from someone else's. | |
answers |
object | Form only: the settled answers keyed by question key. On a replay these are the winning first submit, not this request's. | |
card_sender |
CardIdentityItem |
Sender of the card | |
change_seq |
integer (int64) | yes | Conversation change_seq the record allocated, so the acting device can advance its change watermark. 0 on a replay, which records nothing new. |
interaction_id |
string | yes | Interaction record ID |
interaction_type |
string: choice, form, action |
yes | Echo of the request's interaction_type |
replayed |
boolean | yes | True when this request did not record anything new: a retry under the same key, or a choice or form card that had already been answered. The first answer stands; this is not an error. |
result_at |
string (date-time) | yes | When the recorded interaction took effect. On a replay this is the first record's instant. |
selected_action_ids |
array of string | Choice only: the settled option ids. On a replay these are the winning first answer, not the ids sent in this request. | |
status |
string | yes | Always succeeded: a record exists only for an accepted answer or an effect that happened |
CardStateItem
| Field | Type | Required | Description |
|---|---|---|---|
action_id |
string | yes | Card-local id of the action that was clicked |
actor_id |
string (uuid) | yes | Member UUID that clicked |
form_answers |
object | Settled answer of a form card (kind interaction.form), keyed by question key, holding only the questions the answerer chose something on. Absent on every other card. | |
result_at |
string (date-time) | yes | Click instant, not the instant the server persisted it |
status |
string | yes | Interaction status; always succeeded in v1.0 |
CatalogAgentTierDTO
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | yes | agent_standard|agent_advanced |
name |
string | yes | |
provision_spec |
AgentProvisionDTO |
||
retainer_points_month |
integer (int64) | yes | |
runtime_billing_enabled |
boolean | yes | |
runtime_rate |
AgentRuntimeRateDTO |
||
tier |
string | yes | standard|advanced |
usage_points_day |
integer (int64) | yes |
CatalogCreditPackDTO
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | yes | |
name |
string | yes | |
points |
integer (int64) | yes | |
prices |
array of CatalogPriceDTO |
yes | |
validity_days |
integer (int32) | yes |
CatalogDTO
| Field | Type | Required | Description |
|---|---|---|---|
agent_tiers |
array of CatalogAgentTierDTO |
yes | |
credit_packs |
array of CatalogCreditPackDTO |
yes | |
plans |
array of CatalogPlanDTO |
yes |
CatalogPlanDTO
| Field | Type | Required | Description |
|---|---|---|---|
allow_self_purchase |
boolean | yes | Whether subscribers to this custom plan may purchase credit packs themselves |
allowed_renewal_modes |
array of string | yes | Renewal modes allowed by plan policy: psp|admin_managed |
custom_plan |
boolean | yes | |
entitlements |
EntitlementsDTO |
||
name |
string | yes | |
plan_code |
string | yes | |
plan_family |
string | yes | personal|team; authoritative catalog grouping |
plan_version |
integer (int32) | yes | |
prices |
array of CatalogPriceDTO |
yes |
CatalogPriceDTO
| Field | Type | Required | Description |
|---|---|---|---|
billing_interval |
string | yes | |
currency |
string | yes | |
list_unit_amount_cents |
integer (int64) | yes | Display-only list price in minor units; never used for charging |
price_id |
string | yes | |
unit_amount_cents |
integer (int64) | yes | Minor units (cents); durable charged and renewal price |
ChangeEventBindingStateRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
expected_version |
integer (int64) | yes | Current binding version for optimistic concurrency control |
ChannelConfirmationStatus
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes |
CheckoutHandleDTO
| Field | Type | Required | Description |
|---|---|---|---|
checkout_type |
string | redirect (default; empty means redirect) | qr_code (checkout_url is QR content, render it) | jsapi (checkout_url is JSAPI params, do not navigate) | |
checkout_url |
string | ||
payment_order_id |
string |
ChoiceConfirmInput
| Field | Type | Required | Description |
|---|---|---|---|
label |
string | Confirm button text. Optional; the platform omits the key when empty. | |
text |
string | yes | Confirmation prompt shown before the answer is submitted |
ChoiceInteractionInput
| Field | Type | Required | Description |
|---|---|---|---|
blocks |
array of object | yes | Card body blocks. The platform enforces the permitted block types and fails closed on any other. |
confirm |
ChoiceConfirmInput |
Default confirmation step, applied to every option that declares none of its own. A mixed card should set confirm per option instead. | |
kind |
string | Card family: interaction.choice (the default), onboarding.task, onboarding.channel or onboarding.partner. The platform holds the accepted set and refuses anything else. | |
options |
array of ChoiceOptionInput |
yes | The choices offered. The platform caps how many and rejects duplicate option text. |
summary |
string | One-line summary, also the plain-text projection for clients that cannot render the card. Optional: the platform holds which kinds may omit it and refuses the rest. May be omitted or empty; an explicit null is refused. | |
title |
string | yes | Card title |
ChoiceOptionInput
| Field | Type | Required | Description |
|---|---|---|---|
behavior |
string | What a click does: answer (the default) or open_create_agent. The platform holds the accepted set and which kinds admit each. | |
confirm |
ChoiceConfirmInput |
Confirmation step for this option only. Overrides the card-level confirm; omit to inherit it. | |
decline |
boolean | Marks the option meaning none of these. The platform records its generated id in the card's context.extra.decline_action_id. | |
icon |
string | Icon slug for the client to resolve; never a URL. The platform checks the charset and which kinds admit it. | |
label |
string | yes | Button text. The platform caps the length and rejects two options whose text matches after trim+NFC. |
style |
string | Visual emphasis. The platform holds the accepted set and refuses anything else. |
ClaimConnectShopifyAppInstallRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | Optional connection display name; defaults to "Shopify · |
|
ticket |
string | yes | One-time claim ticket from the claim page URL (/connect/shopify/claim?ticket=...) |
CompleteConnectReauthRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | yes | OAuth code |
raw_params |
object | Verbatim reauth OAuth callback query parameters | |
state |
string | yes | OAuth state |
ConfirmChannelConnectionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | |
channel_type |
string: feishu, lark, dingtalk, wecom |
yes | |
conversation_id |
string (uuid) | yes |
ConnectActionItem
| Field | Type | Required | Description |
|---|---|---|---|
action |
string | yes | |
auth_header_name |
string | ||
description |
string | yes | |
encoding |
string | ||
headers_template |
object | ||
input_schema |
string | yes | |
method |
string | yes | |
params |
array of string | yes | |
request_spec |
any | ||
toolkit |
string | yes | |
url_template |
string |
ConnectAgentBatchAuthorizeData
| Field | Type | Required | Description |
|---|---|---|---|
results |
array of ConnectAgentBatchAuthorizeOk | ConnectAgentBatchAuthorizeFailure |
yes | One result per requested agent after de-duplication, in request order. |
summary |
ConnectAgentBatchAuthorizeSummary |
yes | Counts of results by status. |
ConnectAgentBatchAuthorizeError
| Field | Type | Required | Description |
|---|---|---|---|
code |
string: MEMBER_NOT_FOUND, MEMBER_NOT_AN_AGENT, CONNECT_AGENT_TYPE_NOT_ALLOWED, CONNECT_AGENT_VERSION_TOO_OLD, CONNECT_AGENT_VERSION_UNCONFIRMED |
yes | MEMBER_NOT_FOUND: unknown id, a member of another org, removed or departed (not distinguished). MEMBER_NOT_AN_AGENT: a current org member that is not an agent. CONNECT_AGENT_TYPE_NOT_ALLOWED: an external-invited agent whose runtime type cannot be authorized onto a connection (only the platform's default agent runtime can). CONNECT_AGENT_VERSION_TOO_OLD: runtime version below the minimum (hard block, meta version + minVersion). CONNECT_AGENT_VERSION_UNCONFIRMED: no reported runtime version and confirm was false (meta minVersion). |
message |
string | yes | Human-readable explanation |
meta |
object | Structured values for localization: version / minVersion on the version errors; absent otherwise. |
ConnectAgentBatchAuthorizeFailure
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Agent member UUID, as requested (canonical lowercase form) |
error |
ConnectAgentBatchAuthorizeError |
yes | Why this agent was not authorized. |
status |
string: failed |
yes | The agent was not authorized. |
ConnectAgentBatchAuthorizeOk
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Agent member UUID, as requested (canonical lowercase form) |
authorized_at |
string (date-time) | When the new grant was created; present only for authorized. | |
status |
string: authorized, already_authorized |
yes | authorized: a new grant was created by this request. already_authorized: the agent already held a grant on the connection (counts as success; safe to retry). |
ConnectAgentBatchAuthorizeSummary
| Field | Type | Required | Description |
|---|---|---|---|
already_authorized |
integer (int64) | yes | Agents that already held a grant |
authorized |
integer (int64) | yes | Agents newly authorized by this request |
failed |
integer (int64) | yes | Agents not authorized (see their error) |
ConnectAgentChannelRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
config |
object | yes | Channel form values keyed by field key. Sensitive values are forwarded to the agent runtime and are never persisted or logged by the platform. |
ConnectAgentItem
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string | yes | |
application_id |
string | yes | |
connection_id |
string | yes | |
created_at |
string (date-time) | ||
id |
string | yes |
ConnectAgentUsableConnectionApplication
| Field | Type | Required | Description |
|---|---|---|---|
icon_url |
string | yes | Application icon URL; empty when unset |
id |
string | yes | Application UUID |
name |
string | yes | Application display name |
slug |
string | yes | Application key, e.g. gitlab, google-drive |
ConnectAgentUsableConnectionItem
| Field | Type | Required | Description |
|---|---|---|---|
application |
ConnectAgentUsableConnectionApplication |
yes | The connection's application |
authorized_at |
string (date-time) | yes | When the agent was authorized on this connection |
display_name |
string | yes | Connection display name |
id |
string | yes | Connection UUID |
needs_reauth |
boolean | yes | status is error AND a pending re-authorization request exists (the owner must re-authorize) |
owner_member_id |
string | yes | Member who owns the connection (send re-authorization to them) |
owner_scope |
string | yes | org | personal |
status |
string | yes | pending | active | error | expired | revoked — same vocabulary as list-connect-connections; only active is usable now |
ConnectAgentUsableConnectionsError
| Field | Type | Required | Description |
|---|---|---|---|
code |
string: MEMBER_NOT_FOUND, MEMBER_NOT_AN_AGENT, FORBIDDEN |
yes | MEMBER_NOT_FOUND: unknown id, a member of another org, removed or departed (not distinguished). MEMBER_NOT_AN_AGENT: a current (non-departed, including suspended) org member that is not an agent. FORBIDDEN: the caller may not read this agent's connections. |
message |
string | yes | Human-readable explanation |
ConnectAgentUsableConnectionsFailure
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Agent member UUID, as requested (canonical lowercase form) |
error |
ConnectAgentUsableConnectionsError |
yes | Why this agent could not be read. |
ConnectAgentUsableConnectionsOk
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Agent member UUID, as requested (canonical lowercase form) |
connections |
array of ConnectAgentUsableConnectionItem |
yes | The agent's usable connections matching statuses (possibly []), most recently authorized first. |
ConnectApplicationActionDefItem
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
string | yes | |
created_at |
string (date-time) | ||
description |
string | yes | |
encoding |
string | yes | |
headers |
object | ||
id |
string | yes | |
input_schema |
string | yes | |
method |
string | yes | |
name |
string | yes | |
request_spec |
any | ||
updated_at |
string (date-time) | ||
url_template |
string | yes |
ConnectApplicationCategoryCount
| Field | Type | Required | Description |
|---|---|---|---|
category |
string | yes | Application category |
count |
integer (int64) | yes | Number of applications in this category |
ConnectApplicationCategoryCounts
| Field | Type | Required | Description |
|---|---|---|---|
categories |
array of ConnectApplicationCategoryCount |
yes | Non-empty categories, count descending then category ascending |
total_count |
integer (int64) | yes | Sum of categories[].count: the list-connect-applications total_count for the same filters without a category |
ConnectApplicationItem
| Field | Type | Required | Description |
|---|---|---|---|
api_key_auth_style |
string | ||
api_key_header_name |
string | ||
api_key_location |
string | ||
category |
string | yes | |
connection_count |
integer (int32) | yes | |
connection_state |
string: none, connected, needs_reauth, expired |
Per-caller catalog connection state (list and get): connected > needs_reauth > expired > none | |
connector_kind |
string | ||
created_at |
string (date-time) | ||
created_by |
string | ||
credential_mode |
string | yes | |
credential_source |
string | ||
default_ttl_seconds |
integer (int32) | yes | |
description |
string | yes | |
display_name |
string | yes | |
icon_url |
string | yes | |
id |
string | yes | |
is_connected |
boolean | yes | |
is_enabled |
boolean | yes | |
mcp_template |
object | Connector-level MCP server template (JSON object); omitted when unset | |
needs_reauth_count |
integer (int32) | yes | Number of counted connections that need re-authorization (list and get) |
oauth_authorize_url |
string | yes | |
oauth_callback_url |
string | ||
oauth_client_id |
string | ||
oauth_pkce |
boolean | ||
oauth_scopes_default |
array of string | yes | |
oauth_token_auth_method |
string | ||
oauth_token_body_format |
string | ||
oauth_token_url |
string | yes | |
org_id |
string | ||
provider_type |
string | yes | |
requires_oauth_client_credentials |
boolean | ||
requires_oauth_config_id |
boolean | ||
requires_oauth_instance_host |
boolean | ||
slug |
string | yes | |
sort_order |
integer (int32) | yes | |
source |
string | ||
tags |
array of string | yes | |
updated_at |
string (date-time) | ||
visibility |
string |
ConnectApplicationsQueryError
| Field | Type | Required | Description |
|---|---|---|---|
code |
string: APPLICATION_NOT_FOUND |
yes | APPLICATION_NOT_FOUND: unknown id, a deleted application, or another org's private connector (not distinguished). |
message |
string | yes | Human-readable explanation |
ConnectApplicationsQueryFailure
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
string (uuid) | yes | Application UUID, as requested (canonical lowercase form) |
error |
ConnectApplicationsQueryError |
yes | Why this application could not be read. |
ConnectApplicationsQueryOk
| Field | Type | Required | Description |
|---|---|---|---|
application |
ConnectApplicationItem |
yes | The same item get-connect-application returns for this id, including the caller's connection state. |
application_id |
string (uuid) | yes | Application UUID, as requested (canonical lowercase form) |
ConnectAuthorizedAgentRef
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | Authorized agent member UUID |
authorized_at |
string (date-time) | yes | When the agent was authorized on this connection |
ConnectConnectFieldItem
| Field | Type | Required | Description |
|---|---|---|---|
default |
string | yes | |
description |
string | yes | |
description_i18n |
object | ||
display_name |
string | yes | |
display_name_i18n |
object | ||
is_secret |
boolean | yes | |
legacy_template_name |
string | yes | |
name |
string | yes | |
placeholder |
string | ||
placeholder_i18n |
object | ||
required |
boolean | yes | |
type |
string | yes | |
user_visible |
boolean | yes |
ConnectConnectFieldsData
| Field | Type | Required | Description |
|---|---|---|---|
application_slug |
string | yes | |
fields |
array of ConnectConnectFieldItem |
yes | |
toolkit_slug |
string | yes |
ConnectConnectionItem
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
string | yes | |
application_name |
string | yes | |
application_slug |
string | yes | |
connected_at |
string (date-time) | ||
created_at |
string (date-time) | ||
credential_mode |
string | yes | |
credential_source |
string | yes | |
display_name |
string | yes | |
expires_at |
string (date-time) | ||
external_identity |
string | yes | |
id |
string | yes | |
last_used_at |
string (date-time) | ||
needs_reauth |
boolean | yes | |
org_id |
string | yes | |
owner_member_id |
string | yes | |
owner_scope |
string | yes | |
scopes_granted |
array of string | yes | |
status |
string | yes | |
ttl_seconds |
integer (int32) | yes | |
updated_at |
string (date-time) |
ConnectConnectionWithAgentsItem
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
string | yes | |
application_name |
string | yes | |
application_slug |
string | yes | |
authorized_agents |
array of ConnectAuthorizedAgentRef |
yes | Live agents authorized on this connection, most recently authorized first. Deleted and departed agent members are omitted. Possibly empty, never null. |
connected_at |
string (date-time) | ||
created_at |
string (date-time) | ||
credential_mode |
string | yes | |
credential_source |
string | yes | |
display_name |
string | yes | |
expires_at |
string (date-time) | ||
external_identity |
string | yes | |
id |
string | yes | |
last_used_at |
string (date-time) | ||
needs_reauth |
boolean | yes | |
org_id |
string | yes | |
owner_member_id |
string | yes | |
owner_scope |
string | yes | |
scopes_granted |
array of string | yes | |
status |
string | yes | |
ttl_seconds |
integer (int32) | yes | |
updated_at |
string (date-time) |
ConnectCreateConnectionData
| Field | Type | Required | Description |
|---|---|---|---|
connection |
ConnectConnectionItem |
yes | |
discovery_status |
string | yes | |
redirect_url |
string | yes |
ConnectCreateConnectionMcpServerInput
| Field | Type | Required | Description |
|---|---|---|---|
args |
array of string | Argument vector for the stdio command | |
auth_type |
string | MCP auth type: none (default), bearer, or oauth. A stdio server accepts only none — its secrets live inline in raw_config env; stdio with any other auth_type (or with an api_key on the api-key path) is rejected with 400. | |
command |
string | Local executable to spawn (stdio transport) | |
env |
array of ConnectMcpEnvInput |
Structured per-env-var copy of a stdio MCP server's environment: each {name, value, is_secret}. stdio only; names non-empty and unique (case-sensitive); is_secret=true requires a non-empty value and envelope-encrypts it at rest. A redaction copy only — raw_config remains the launch source and env is never returned. Validated server-side. | |
headers |
array of ConnectMcpHeaderInput |
Structured per-header custom headers for a remote_http MCP server: each {name, value, is_secret}. is_secret=true (remote_http only) envelope-encrypts the value at rest; validated server-side. Supersedes headers_template when non-empty. | |
headers_template |
object | Non-secret HTTP headers to send to the MCP server, as a name→value map | |
raw_config |
any | Complete canonical MCP server JSON (single server object or single-entry {"mcpServers":{...}} wrapper), forwarded verbatim. REQUIRED for every new MCP connection and must be launchable on its own (stdio: non-empty command; remote_http: non-empty url; declared transport must match), else 400. It is the sole launch source and carries secrets as their real values; the platform encrypts it as a whole at rest and never returns it except to a bound agent via acquire. | |
server_url |
string | Remote MCP server URL (remote_http transport) | |
transport |
string | MCP transport: remote_http (default) or stdio |
ConnectCursorListResponseConnectActionItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectActionItem |
yes | Response payload |
next_cursor |
string | Cursor for the next page; omitted when there are no more results | |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
total_count |
integer (int64) | Total number of matching applications across all pages; present for paginated requests | |
total_pages |
integer (int32) | Total number of numbered pages (ceil(total_count/page_size)); present only in numbered mode |
ConnectCursorListResponseConnectApplicationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectApplicationItem |
yes | Response payload |
next_cursor |
string | Cursor for the next page; omitted when there are no more results | |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
total_count |
integer (int64) | Total number of matching applications across all pages; present for paginated requests | |
total_pages |
integer (int32) | Total number of numbered pages (ceil(total_count/page_size)); present only in numbered mode |
ConnectExecuteActionData
| Field | Type | Required | Description |
|---|---|---|---|
body |
any | ||
status_code |
integer (int32) | yes |
ConnectInitiateReauthData
| Field | Type | Required | Description |
|---|---|---|---|
reauth_request_id |
string | yes | |
redirect_url |
string | yes |
ConnectMcpEnvInput
| Field | Type | Required | Description |
|---|---|---|---|
is_secret |
boolean | Envelope-encrypt this env value at rest. Supported only for transport=stdio. | |
name |
string | yes | Env var name (required, non-empty, unique case-sensitively; validated by the platform) |
value |
string | Env var value (plaintext on input); required when is_secret=true |
ConnectMcpHeaderInput
| Field | Type | Required | Description |
|---|---|---|---|
is_secret |
boolean | Envelope-encrypt this header's value at rest. Supported only for transport=remote_http; the platform rejects is_secret=true on a stdio server. | |
name |
string | yes | Header name (required, non-empty; validated by the platform) |
value |
string | Header value (plaintext on input). On update, an is_secret=true entry with an empty value keeps the existing stored ciphertext for this header name unchanged; a non-empty value (re-)encrypts. |
ConnectOAuthCallbackURLData
| Field | Type | Required | Description |
|---|---|---|---|
callback_url |
string | yes |
ConnectProxyForwardData
| Field | Type | Required | Description |
|---|---|---|---|
body |
any | ||
headers |
object | yes | |
status_code |
integer (int32) | yes |
ConnectShopifyAppInstallItem
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string (date-time) | When the ticket stops being claimable | |
shop |
string | yes | The verified, lowercase *.myshopify.com host the ticket was issued for: the shop a claim would connect |
ConnectToolkitItem
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
string | yes | |
config_template |
any | ||
description |
string | yes | |
display_name |
string | yes | |
id |
string | yes | |
install_command |
string | yes | |
install_url |
string | yes | |
mcp_config |
any | ||
native_command |
string | yes | |
requires_direct |
boolean | yes | |
skill_manifest |
any | ||
slug |
string | yes | |
tool_type |
string | yes | |
version |
string | yes |
ConversationChangeItem
| Field | Type | Required | Description |
|---|---|---|---|
change_seq |
integer (int64) | yes | Conversation change number |
created_at |
integer (int64) | yes | When the change happened (unix ms) |
kind |
string: UNSPECIFIED, EDITED, RECALLED, DELETED, REACTION_ADDED, REACTION_REMOVED, CARD_INTERACTION |
yes | Kind of the change. A hint only: refetch the message by id with batch-get-messages whatever the kind; the only shortcut is that a DELETED message can be removed locally. |
message_id |
string | yes | Changed message ID |
message_seq |
integer (int64) | yes | The changed message's seq, so a client can keep only the ids inside the range it holds locally |
ConversationChangesResult
| Field | Type | Required | Description |
|---|---|---|---|
changes |
array of ConversationChangeItem |
yes | Ascending by change_seq; a message appears at most once per page (its last change in the page). Empty when too_old. |
has_more |
boolean | yes | True while next_since_change_seq < head_change_seq |
head_change_seq |
integer (int64) | yes | The conversation's change-log head as of these changes |
next_since_change_seq |
integer (int64) | yes | The largest change_seq scanned in this page; equals the request's since_change_seq on an empty page. Pass it as the next since_change_seq. |
too_old |
boolean | yes | True when the changes after since_change_seq can no longer be listed (cleaned by retention, or since_change_seq is beyond the head). Drop the local segment, refetch the newest window with list-messages and initialize the watermark from its head_change_seq. |
ConversationConnectorItem
| Field | Type | Required | Description |
|---|---|---|---|
connector_id |
string | yes | |
conversation_id |
string | yes | |
enabled |
boolean | yes |
ConversationConnectorList
| Field | Type | Required | Description |
|---|---|---|---|
connectors |
array of ConversationConnectorItem |
yes |
ConversationItem
| Field | Type | Required | Description |
|---|---|---|---|
agent_collab_participants |
array of AgentCollabParticipantItem |
Agent collaboration participants for observed agent DM conversations | |
archived_at |
string (date-time) | Archived time | |
archived_reason |
string: owner, app_uninstalled |
Why an archived sub-conversation is read-only: owner (its owner archived it) or app_uninstalled (the owning app was uninstalled; a reinstall lifts it). Omitted otherwise. | |
avatar_url |
string | Avatar URL | |
bridge |
BridgeDetailItem |
Bridge details | |
broadcast |
BroadcastDetailItem |
Broadcast details | |
can_mention_all |
boolean | yes | Whether the current user can use @all/@all_agents in this conversation. Only populated by get-conversation; list responses always return false. |
context_key |
string | The owner's opaque key of this sub-conversation (1-128 characters of [a-z0-9:_-]), unique per (parent, owner). | |
context_owner_app_id |
string (uuid) | The owning app's app_id when context_owner_kind is app (stable across uninstall and reinstall). | |
context_owner_kind |
string: app, platform |
Who owns this sub-conversation: an app (context_owner_app_id) or the platform (reply topics, context_key message: |
|
context_title |
string | Display title of this sub-conversation, set by its owner. | |
created_at |
string (date-time) | yes | Creation time |
dm |
DmDetailItem |
DM details | |
group |
GroupDetailItem |
Group details | |
id |
string (uuid) | yes | Conversation UUID |
is_observer |
boolean | yes | Whether this conversation is visible through observation |
last_message_at |
string (date-time) | yes | Last message time |
last_message_id |
integer (int64) | Last message ID | |
last_message_preview |
LastMessagePreviewItem |
Last message preview | |
member_count |
integer (int32) | yes | Member count |
name |
string | Conversation name | |
owner_id |
string (uuid) | Owner member UUID | |
parent_conversation_id |
string (uuid) | Parent conversation UUID when this is a context sub-conversation; omitted on an ordinary conversation. Not named parent_id, which clients use for the replied-to message. | |
read_receipt_mode |
string | yes | Caller-perspective read-receipts mode: "full" when delivered/read indicators should render, otherwise "none". Only populated by get-conversation; list responses always return empty (same posture as can_mention_all). |
type |
string: UNSPECIFIED, DM, GROUP, STRAT, BROADCAST, BRIDGE |
yes | Conversation type: DM, GROUP, STRAT, BROADCAST or BRIDGE; UNSPECIFIED only when the type is unknown. |
unread_count |
integer (int32) | yes | Unread message count |
ConversationMemberBatchResponse
| Field | Type | Required | Description |
|---|---|---|---|
results |
array of ConversationMemberBatchResult |
yes | Per-member operation results |
summary |
ConversationMemberBatchSummary |
yes | Batch operation summary |
ConversationMemberBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | Stable error code when this member operation failed | |
member_id |
string (uuid) | yes | OrgMember/Participant UUID |
message |
string | Human-readable error message when this member operation failed | |
status |
integer (int64) | yes | HTTP-equivalent status for this member operation |
success |
boolean | yes | Whether this member operation succeeded |
ConversationMemberBatchSummary
| Field | Type | Required | Description |
|---|---|---|---|
duplicates |
integer (int64) | yes | Number of duplicate member IDs skipped before execution |
failed |
integer (int64) | yes | Number of failed member operations |
invalid |
integer (int64) | yes | Number of invalid member IDs skipped before execution |
success |
integer (int64) | yes | Number of successful member operations |
total |
integer (int64) | yes | Number of requested member operations |
unique_total |
integer (int64) | yes | Number of unique non-empty member IDs processed |
ConversationMemberItem
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Resolved member avatar URL; omitted when unresolved | |
display_name |
string | yes | Org member display name, resolved server-side. Empty when the member cannot be resolved in the caller's org (e.g. cross-org or hard-deleted member); clients must render a placeholder rather than the raw UUID. |
is_muted |
boolean | yes | Whether the member has muted the conversation |
is_pinned |
boolean | yes | Whether the member has pinned the conversation |
joined_at |
string (date-time) | yes | Join time |
kind |
string: human, agent |
Resolved member kind; omitted when unresolved | |
last_ack_seq |
integer (int64) | yes | Last acknowledged sequence |
last_read_seq |
integer (int64) | yes | Last read sequence |
member_id |
string (uuid) | yes | OrgMember/Participant UUID |
nickname |
string | Member nickname | |
role |
string: UNSPECIFIED, MEMBER, ADMIN, OWNER, PUBLISHER, SUBSCRIBER |
yes | Conversation member role |
ConversationResourceItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | Images and files: the artifact to resolve for preview or download | |
content_type |
string | Images and files: MIME type | |
conversation_id |
string (uuid) | yes | Conversation the message is in (a sub-conversation's own ID for its messages) |
file_name |
string | Images and files: file name | |
id |
string | yes | Resource ID |
kind |
string: image, file, link |
yes | Resource kind: image and file carry artifact_id, link carries url |
link_text |
string | Links: the link text, when the message gave one | |
media_id |
string | Images and files: the upload record, when there is one | |
message_at |
string (date-time) | yes | Time of the message that carries the resource (the sort key) |
message_id |
string | yes | ID of the message that carries the resource |
message_seq |
integer (int64) | yes | Conversation sequence of that message |
root_conversation_id |
string (uuid) | yes | Top-level conversation: conversation_id itself, or the parent of a sub-conversation |
sender_id |
string (uuid) | yes | Sender member UUID |
sender_type |
string: UNSPECIFIED, HUMAN, AGENT, SYSTEM |
yes | Sender type |
size_bytes |
integer (int64) | Images and files: size in bytes | |
url |
string | Links: the normalized URL | |
url_host |
string | Links: the URL's host |
ConversationWorkLinkItem
| Field | Type | Required | Description |
|---|---|---|---|
anchor_message_id |
string | Message the link is anchored to, when there is one | |
issue |
IssueItem |
yes | The linked Issue, as get-issue returns it; status, terminated_at and archived_at tell ended Issues apart |
link_id |
string (uuid) | yes | Issue-conversation link UUID |
link_role |
string: origin, discussion, delivery, approval, handoff |
yes | How the Issue relates to the conversation; origin = created from it |
linked_at |
string (date-time) | yes | Link creation time |
CreateAppAgentGrantRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_id |
string (uuid) | yes | The Agent (member ID) the calling app may act as; the caller must be its owner |
CreateApprovalRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
action |
string | Requested action | |
approver_member_id |
string (uuid) | Approver member UUID | |
detail |
any | Approval request detail | |
kind |
string: resource_grant, external_share |
yes | Approval request kind |
policy_id |
string (uuid) | Approval policy UUID | |
request_expires_at |
string (date-time) | Request expiry time | |
request_reason |
string | Request reason | |
scope_id |
string (uuid) | yes | Scope/resource UUID |
scope_type |
string | yes | Scope/resource type |
CreateBlueprintRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
estimated_budget |
object | Estimated budget JSON object | |
notes |
string | Blueprint notes | |
steps |
array of StepInput |
yes | Blueprint steps |
CreateConnectAPIKeyConnectionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
api_key |
string | API key credential (single-value shortcut; optional when the multi-field 'fields' map is used instead) | |
application_slug |
string | yes | Application slug |
base_url |
string | Per-connection base URL (required for applications with no fixed host, e.g. Jenkins) | |
display_name |
string | Connection display name | |
fields |
object | Multi-field API key credential values keyed by connect-field name (see the application's connect-fields schema: the provider's field names for provider-hosted api_key toolkits, or api_key/username/base_url for managed api_key connectors); used exactly as sent | |
mcp_server |
ConnectCreateConnectionMcpServerInput |
Per-connection MCP server configuration (connector_kind=mcp, none/bearer auth only; bearer/api_key is remote_http-only — a stdio server must use auth_type=none with no api_key); omit for ordinary api_key and provider-hosted connections | |
org_id |
string (uuid) | Organization UUID | |
owner_member_id |
string (uuid) | Owner member UUID | |
owner_scope |
string | yes | Owner scope |
username |
string | Username (required when the application's api_key_auth_style is 'basic', e.g. Jenkins) |
CreateConnectApplicationActionDefRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | yes | Action description (required, non-empty) |
encoding |
string | Request body encoding | |
headers |
object | Header template | |
input_schema |
string | JSON schema for action inputs | |
method |
string | yes | HTTP method |
name |
string | yes | Action name |
request_spec |
any | Optional request_spec JSON object (direct-mode body template / files / upload / batch). Validated by the platform; encoding must then be empty | |
url_template |
string | yes | URL template |
CreateConnectApplicationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
api_key_header_name |
string | API key header/param name | |
api_key_location |
string | API key location: header or query | |
category |
string | Category | |
connector_kind |
string | Connector transport kind: http (default) or mcp | |
default_ttl_seconds |
integer (int32) | Default credential TTL in seconds | |
description |
string | Description | |
display_name |
string | yes | Display name |
icon_url |
string | Icon URL | |
oauth_authorize_url |
string | OAuth authorize URL | |
oauth_client_id |
string | OAuth client ID | |
oauth_client_secret |
string | OAuth client secret | |
oauth_pkce |
boolean | Whether OAuth uses PKCE | |
oauth_scopes_default |
array of string | Default OAuth scopes | |
oauth_token_auth_method |
string | OAuth token auth method: basic or post | |
oauth_token_body_format |
string | OAuth token body format: form or json | |
oauth_token_url |
string | OAuth token URL | |
provider_type |
string | yes | Provider type |
slug |
string | Application slug (optional; generated by OpenMax when omitted) | |
tags |
array of string | Tags |
CreateConnectConnectionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
application_slug |
string | yes | Application slug |
display_name |
string | Connection display name | |
mcp_server |
ConnectCreateConnectionMcpServerInput |
Per-connection MCP server configuration (connector_kind=mcp only); omit for http, provider-hosted and managed connections | |
oauth_client_id |
string | Per-connection (BYO) OAuth client ID; required only for applications that need per-connection client credentials (e.g. Shopify custom apps) | |
oauth_client_secret |
string | Per-connection (BYO) OAuth client secret; required only for applications that need per-connection client credentials (e.g. Shopify custom apps). Stored encrypted, never returned in any response. | |
oauth_config_id |
string | Per-connection Facebook Login for Business configuration ID; required only for applications that declare requires_oauth_config_id (e.g. Meta with your own app). Stored encrypted and not returned in connection records; it appears only as the config_id parameter of the returned redirect_url. | |
oauth_instance_host |
string | Per-connection OAuth host for per-tenant connectors (e.g. Shopify's {shop}.myshopify.com); required only when the application declares requires_oauth_instance_host | |
org_id |
string (uuid) | Organization UUID | |
owner_member_id |
string (uuid) | Owner member UUID | |
owner_scope |
string | yes | Owner scope |
CreateDMSubConversationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
context_key |
string | yes | As for create-subconversation. |
peer_member_id |
string (uuid) | yes | The DM peer (OrgMember/Participant UUID). The caller's main DM with this member is found or created and the sub-conversation hangs under it. |
title |
string | Display title. On an existing unarchived sub-conversation it replaces the title. |
CreateEventBindingRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
anchor_at |
string (date-time) | Interval phase anchor instant | |
authorization_card_interaction_id |
string (uuid) | ||
authorization_confirmation_message_id |
string | ||
authorization_proposal_message_id |
string | ||
cron_expr |
string | 5-field cron expression, required for cron schedules | |
interval_seconds |
integer (int64) | Elapsed interval in seconds | |
lead_member_id |
string (uuid) | yes | Lead agent member UUID (executor) |
owner_member_id |
string (uuid) | Human Owner UUID; omitted defaults to the human caller. Agent callers require an explicit human Owner | |
project_member_additions |
array of string | Members added to spec.project_id atomically with this write: only lead_member_id and/or owner_member_id, each once. The acting human (caller, or the confirming human for Agent writes) needs project write access. Must be empty for the Inbox | |
result_notification_policy |
string: every, failure_only, none |
Final result DM policy; omitted timer creates default to every. HTTP null is tolerated as omission | |
run_at |
string (date-time) | Once trigger instant | |
schedule_kind |
string: cron, once, interval |
Schedule mode; omitted means cron | |
spec |
SpecStruct |
yes | |
timezone |
string | IANA timezone |
CreateFileNodeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string (uuid) | yes | Artifact UUID |
name |
string | yes | File node name |
parent_id |
string (uuid) | Parent node UUID |
CreateFolderRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Folder name |
parent_id |
string (uuid) | Parent node UUID |
CreateGroupRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_media_id |
string | Avatar media UUID | |
description |
string | Group description | |
member_ids |
array of string | yes | Initial OrgMember/Participant UUIDs |
metadata |
object | Optional metadata | |
name |
string | yes | Group name |
CreateGroupResult
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
id |
string (uuid) | yes | Created group conversation UUID |
member_count |
integer (int32) | yes | Member count |
CreateInvitationData
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Invitee's org-level member display name |
expires_at |
string (date-time) | yes | Invitation expiry |
invitation_id |
string (uuid) | yes | Created invitation UUID |
status |
string | yes | Invitation status (pending) |
token |
string | Invitation token (returned for agent invitations where email is omitted) |
CreateInvitationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Invitee's org-level member display name |
email |
string (email) | Invitee email (for human invitations). Omit for agent invitations — use the returned token for programmatic delivery. | |
message |
string | Optional invitation message | |
phone_cc |
string | Invitee phone country calling code, digits only, no '+' (e.g. '86'). Paired with phone_number. | |
phone_number |
string | Invitee national phone number without the country code. Paired with phone_cc. | |
role_id |
string (uuid) | yes | Initial role to assign upon acceptance |
CreateIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
backlog |
boolean | Whether to create in backlog. Defaults to true when omitted; set false to start in_progress | |
description |
string | Issue description | |
lead_agent_id |
string (uuid) | yes | Lead agent UUID |
origin_conversation_id |
string (uuid) | Origin conversation UUID | |
origin_message_id |
string (uuid) | Origin message UUID | |
owner_member_id |
string (uuid) | yes | Issue owner member UUID (required) |
priority |
string: low, medium, high |
Issue priority (optional, default medium) | |
title |
string | yes | Issue title |
CreateIssueRevisionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | yes | |
idempotency_key |
string | yes | |
origin_message_id |
string |
CreateKBRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | KB description | |
icon |
string | KB icon | |
name |
string | yes | KB name |
visibility |
string: open, closed, private |
yes | KB visibility |
CreatePageRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
body |
string | yes | Page content body |
format |
string: markdown, plain_text |
yes | Page format |
message |
string | Revision message | |
parent_id |
string (uuid) | Parent node UUID | |
title |
string | yes | Page title |
CreateProjectRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Project description | |
is_default |
boolean | Whether this is the organization default project | |
knowledge_base_id |
string (uuid) | Knowledge base UUID; if omitted the org default KB is used (a private project uses the caller's personal knowledge base) | |
lead_member_id |
string (uuid) | Lead member UUID. Required for an organization project; for a private project omit it or pass the caller (the owner is always the lead). | |
member_ids |
array of string | Initial project member UUIDs created atomically with the project; for a private project only the caller's own active Agents | |
name |
string | yes | Project name |
scope |
string: org, private |
org (default) or private. A private project is visible only to its owner (the caller) and the owner's Agents that are members; creating one needs automation_private_scope_enabled. | |
slug |
string | Optional project slug. Auto-generated from name when omitted. |
CreateSubConversationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
context_key |
string | yes | The owner's key for this sub-conversation: 1-128 characters of [a-z0-9:_-] (400 COMM_INVALID_CONTEXT_KEY otherwise). A caller that is not an app access token acts as the platform and may only create reply topics, message: |
owner |
SubConversationOwnerInput |
Ignored for app access tokens; see the field docs. The owner is always taken from the credential. | |
title |
string | Display title. On an existing unarchived sub-conversation it replaces the title. |
CreateTaskRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
assignee_id |
string (uuid) | Assignee member UUID | |
blueprint_step_id |
string (uuid) | Blueprint step UUID | |
depends_on |
array of string (uuid) | Task dependency UUIDs | |
description |
string | Task description | |
title |
string | yes | Task title |
CreatedPageItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
creator_avatar_url |
string | Creator avatar URL | |
creator_id |
string | yes | Creator principal ID |
creator_name |
string | Creator display name | |
creator_type |
string: user, agent, team, system |
yes | Creator entity type |
current_revision_id |
integer (int64) | Current revision ID | |
format |
string: markdown, plain_text |
yes | Page format |
id |
string (uuid) | yes | Page UUID |
kb_id |
string (uuid) | yes | KB UUID |
last_edited_by |
string | Last editor principal ID | |
last_edited_by_type |
string: user, agent, team, system |
Last editor entity type | |
last_editor_avatar_url |
string | Last editor avatar URL | |
last_editor_name |
string | Last editor display name | |
node_id |
string (uuid) | yes | Created tree node UUID |
org_id |
string (uuid) | yes | Organization UUID |
path |
string | yes | Page path |
status |
string: active, trashed |
yes | Page status |
title |
string | yes | Page title |
trashed_at |
string (date-time) | Trash time | |
updated_at |
string (date-time) | yes | Last update time |
Credential
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | |
created_by_departed |
boolean | yes | |
created_by_display_name |
string | yes | |
created_by_identity_id |
string | yes | |
id |
string | yes | |
last_operation_id |
string | yes | |
prefix |
string | yes | |
revision |
integer (int64) | yes | |
revoked_at |
string (date-time) | ||
scope |
string | yes | |
status |
string | yes |
CreditBreakdownDTO
| Field | Type | Required | Description |
|---|---|---|---|
activity |
CreditBucketDTO |
yes | |
purchased |
CreditBucketDTO |
yes | |
subscription |
CreditBucketDTO |
yes | |
total_available |
integer (int64) | yes |
CreditBucketDTO
| Field | Type | Required | Description |
|---|---|---|---|
period_limit |
integer (int64) | yes | Current subscription-period grant total; zero for purchased/activity buckets |
remaining |
integer (int64) | yes |
CreditGrantDTO
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | ||
expires_at |
string (date-time) | ||
grant_id |
integer (int64) | yes | |
points_remaining |
integer (int64) | yes | |
points_total |
integer (int64) | yes | |
source |
string | yes | |
source_ref |
string | ||
status |
string | yes |
CreditStatementDTO
| Field | Type | Required | Description |
|---|---|---|---|
balance |
integer (int64) | yes | |
balance_as_of |
string (date-time) | ||
consumptions |
array of CreditStatementEntryDTO |
yes | |
expiries |
array of CreditStatementEntryDTO |
yes | |
grants |
array of CreditStatementEntryDTO |
yes | |
has_more |
boolean | yes | |
manual_adjustments |
array of CreditStatementEntryDTO |
yes | Manual deductions, separate from consumption and usage totals; points are positive magnitudes |
CreditStatementEntryDTO
| Field | Type | Required | Description |
|---|---|---|---|
addon_id |
string | ||
agent_identity |
string | Agent identity the entry billed (consumptions only) | |
agent_name |
string | Resolved agent display name; null when unresolvable (member deleted) | |
category |
string | Statement category: agent_retainer | agent_usage_prepay | agent_runtime_hourly | llm_usage (consumptions only; empty when uncategorizable) | |
charge_id |
integer (int64) | ||
display_description |
string | User-visible manual adjustment description; never the internal operation reason | |
display_name |
string | User-visible manual adjustment name; may be absent | |
kind |
string | yes | grant|consumption|expiry|adjustment |
ledger_id |
string | Opaque decimal ledger ID for manual adjustments; preserve as a string | |
occurred_at |
string (date-time) | ||
online_minutes |
integer (int64) | ||
online_points_micro_per_minute |
integer (int64) | Exact online rate; 1 credit = 1e6 micro-points | |
outstanding_points |
integer (int64) | ||
points |
integer (int64) | yes | |
points_micro |
integer (int64) | Exact pre-carry runtime-hour amount in micro-points | |
points_total |
integer (int64) | ||
settled_points |
integer (int64) | ||
sku_code |
string | ||
sleep_minutes |
integer (int64) | ||
sleep_points_micro_per_minute |
integer (int64) | Exact sleep rate; 1 credit = 1e6 micro-points | |
source |
string | ||
source_ref |
string | ||
status |
string | charged | insufficient_funds for charge-backed consumption rows |
CursorListResponseAgentCollabConversationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AgentCollabConversationItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseAppAgentGrantItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AppAgentGrantItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseCardInteractionAuditItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of CardInteractionAuditItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseConversationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConversationItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseConversationResourceItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConversationResourceItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseConversationWorkLinkItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConversationWorkLinkItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseEventBindingChangeItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of EventBindingChangeItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseKbSummaryItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of KbSummaryItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseMessageItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of MessageItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseMessageSearchHitItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of MessageSearchHitItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponsePageItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of PageItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseRevisionSummaryItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of RevisionSummaryItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseSearchHitItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of SearchHitItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorListResponseUserConversationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of UserConversationItem |
yes | Response payload |
pagination |
CursorMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
CursorMetadata
| Field | Type | Required | Description |
|---|---|---|---|
next_cursor |
string | yes | Cursor for the next page (empty string if no more pages) |
total_count |
integer (int64) | Total number of matching items; omitted when the service does not compute a total |
D8Error
| Field | Type | Required | Description |
|---|---|---|---|
error |
D8ErrorPayload |
yes | Error payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
D8ErrorPayload
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | Stable business error code (business errors only) | |
detail |
string | A human-readable explanation specific to this occurrence of the problem | |
errors |
array of ErrorDetail |
Optional list of individual error details (validation errors) | |
field |
string | Offending request field, when attributable (business errors only) | |
instance |
string (uri) | A URI reference that identifies the specific occurrence of the problem | |
meta |
object | Structured, machine-readable fields for this error, letting clients localize detail while rendering live values (business errors only, when present) | |
status |
integer (int64) | yes | HTTP status code |
title |
string | A short, human-readable summary of the problem type | |
type |
string (uri) | A URI reference to human-readable documentation for the error |
DataResponseAcceptInvitationDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AcceptInvitationData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAddonOutstandingDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AddonOutstandingDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAdminAgentStorageDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AdminAgentStorageDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAgentAvatarDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentAvatarData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAgentCapabilityTagsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentCapabilityTagsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAgentChannelBindingItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentChannelBindingItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAgentCreditCapDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentCreditCapDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAgentRuntimeMetricsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentRuntimeMetricsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAnalyticsOverviewBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AnalyticsOverview |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAppAgentGrantItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AppAgentGrantItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseApprovalItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ApprovalItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAttemptItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AttemptItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutoTopupSettingsDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutoTopupSettingsDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutomationAuthorizationPreviewBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutomationAuthorizationPreview |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutomationCreationEligibilityBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutomationCreationEligibility |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutomationHandoffResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutomationHandoffResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutomationProposalResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutomationProposalResponse |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAutomationProposalStatusBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AutomationProposalStatus |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAvatarUploadFinalizedBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AvatarUploadFinalized |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseAvatarUploadPreparedBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AvatarUploadPrepared |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBalanceAlertSettingsDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BalanceAlertSettingsDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBatchAgentDMEligibilityResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BatchAgentDMEligibilityResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBatchGetMessagesResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BatchGetMessagesResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBillingCapabilitiesDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BillingCapabilitiesData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBillingPaymentOptionsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BillingPaymentOptionsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseBlueprintItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
BlueprintItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCapabilityTagVocabularyDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CapabilityTagVocabularyData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCardChoiceResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CardChoiceResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCardInteractionResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CardInteractionResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCardInteractionSubmitResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CardInteractionSubmitResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCatalogDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CatalogDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseChannelConfirmationStatusBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ChannelConfirmationStatus |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectActionItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectActionItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectAgentBatchAuthorizeDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectAgentBatchAuthorizeData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectApplicationActionDefItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectApplicationActionDefItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectApplicationCategoryCountsBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectApplicationCategoryCounts |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectApplicationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectApplicationItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectConnectFieldsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectConnectFieldsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectConnectionItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectConnectionItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectCreateConnectionDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectCreateConnectionData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectExecuteActionDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectExecuteActionData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectInitiateReauthDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectInitiateReauthData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectOAuthCallbackURLDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectOAuthCallbackURLData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectProxyForwardDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectProxyForwardData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConnectShopifyAppInstallItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConnectShopifyAppInstallItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConversationChangesResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConversationChangesResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConversationConnectorItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConversationConnectorItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConversationConnectorListBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConversationConnectorList |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConversationItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConversationItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseConversationMemberBatchResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ConversationMemberBatchResponse |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCreateGroupResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CreateGroupResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCreateInvitationDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CreateInvitationData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCreatedPageItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CreatedPageItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseCreditStatementDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
CreditStatementDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseDisconnectAgentChannelDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
DisconnectAgentChannelData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseEditMessageResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
EditMessageResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseEventBindingItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
EventBindingItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseEventBindingPreviewBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
EventBindingPreview |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseEventBindingRunBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
EventBindingRun |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseFileDownloadItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
FileDownloadItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseFilePreviewItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
FilePreviewItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseFinalizeUploadResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
FinalizeUploadResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseFindOrCreateDMResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
FindOrCreateDMResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseGetMeDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
GetMeData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseGetMessageResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
GetMessageResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseHeldWebhookEventsBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
HeldWebhookEvents |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseHeldWebhookEventsDecisionBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
HeldWebhookEventsDecision |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInboxStatusResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InboxStatusResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInitOrgKBDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InitOrgKBData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInstallmentScheduleDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InstallmentScheduleDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInteractionRequestResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InteractionRequestResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInvoiceApplicationDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InvoiceApplicationDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInvoiceArtifactDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InvoiceArtifactDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseInvoiceSummaryDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
InvoiceSummaryDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseIssueItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
IssueItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseKbItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
KbItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseLeaveGroupResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
LeaveGroupResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListAgentChannelCatalogItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AgentChannelCatalogItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListAgentCreditCapDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AgentCreditCapDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListAgentProfileBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AgentProfile |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectAgentItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectAgentItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectAgentUsableConnectionsEntryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectAgentUsableConnectionsOk | ConnectAgentUsableConnectionsFailure |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectApplicationActionDefItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectApplicationActionDefItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectApplicationsQueryEntryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectApplicationsQueryOk | ConnectApplicationsQueryFailure |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectConnectionItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectConnectionItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectConnectionWithAgentsItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectConnectionWithAgentsItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConnectToolkitItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConnectToolkitItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListConversationMemberItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ConversationMemberItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListEventBindingItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of EventBindingItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListEventOccurrenceItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of EventOccurrenceItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListFileDownloadResultItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of FileDownloadResultItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListMessageEditsResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ListMessageEditsResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListMyInvitationsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ListMyInvitationsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListMyProvisioningAgentSummaryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of MyProvisioningAgentSummary |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListObservedMemberItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ObservedMemberItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListObserverMemberItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ObserverMemberItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListOwnedAgentSummaryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of OwnedAgentSummary |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListPageReferenceItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of PageReferenceItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListPlatformAgentOperationalStateDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of PlatformAgentOperationalStateDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListTreeNodeItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of TreeNodeItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListTreeNodeWithChildrenItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of TreeNodeWithChildrenItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListWebhookDeliveryItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of WebhookDeliveryItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseListWorkReferenceItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of WorkReferenceItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseMapStringBoolBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
object | yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseMapStringInterface {}Body
| Field | Type | Required | Description |
|---|---|---|---|
data |
object | yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseMarkMentionsReadResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
MarkMentionsReadResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseMarkReadResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
MarkReadResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseMentionQueueResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
MentionQueueResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseModelCatalogDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ModelCatalogData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseOrderCheckoutDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
OrderCheckoutDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseOrderFateDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
OrderFateDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseOrderHistoryDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
OrderHistoryDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseOrganizationDeletionPrecheckDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
OrganizationDeletionPrecheckData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseOrganizationDetailBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
OrganizationDetail |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePageContentItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PageContentItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePageItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PageItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePaymentMethodListDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PaymentMethodListDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePlanStateDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PlanStateDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePlatformAgentDomainAvailabilityDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PlatformAgentDomainAvailabilityData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePlatformAgentDomainConfigDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PlatformAgentDomainConfigData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePlatformAgentDomainDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PlatformAgentDomainData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePollAgentDingtalkScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PollAgentDingtalkScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePollAgentFeishuScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PollAgentFeishuScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePollAgentLarkScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PollAgentLarkScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePollAgentWecomScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PollAgentWecomScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePrepareUploadItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PrepareUploadItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePrepareUploadResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PrepareUploadResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePrivateWorkspaceResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PrivateWorkspaceResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponsePrivateWorkspaceStatusBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
PrivateWorkspaceStatus |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseProjectItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ProjectItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseProjectMemberItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ProjectMemberItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseQuotaBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
Quota |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseReactionChangeResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ReactionChangeResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseReadCursorsResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ReadCursorsResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseRecallMessageResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
RecallMessageResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseResolveURIsDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
ResolveURIsData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseRevisionDiffItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
RevisionDiffItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSendMessageResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SendMessageResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSetAppBadgesDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SetAppBadgesData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStarListBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StarList |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartAgentDingtalkScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartAgentDingtalkScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartAgentFeishuScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartAgentFeishuScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartAgentLarkScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartAgentLarkScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartAgentWecomScanDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartAgentWecomScanData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartAgentWhatsappBusinessRegistrationDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartAgentWhatsappBusinessRegistrationData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStartTaskDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
StartTaskData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseStruct {}Body
| Field | Type | Required | Description |
|---|---|---|---|
data |
DataStruct |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSubConversationResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SubConversationResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSubmitAgentWhatsappBusinessCodeDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SubmitAgentWhatsappBusinessCodeData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSubscriptionIntentReadDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SubscriptionIntentReadDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseSyncResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
SyncResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseTaskItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
TaskItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseTimezonesDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
TimezonesData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseTreeNodeItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
TreeNodeItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseUnreadCountResultBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UnreadCountResult |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseUpdateMeDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UpdateMeData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseUpdateMemberDisplayNameDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UpdateMemberDisplayNameData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseUpdateOrganizationDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UpdateOrganizationData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseUsageSummaryDTOBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UsageSummaryDTO |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseWebhookDeliveryItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
WebhookDeliveryItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseWebhookItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
WebhookItem |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataResponseWsTicketDataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
WsTicketData |
yes | Response payload |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
DataStruct
object
DecideApprovalRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Decision reason | |
status |
string: approved, rejected |
yes | Decision status |
DecideHeldWebhookEventsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
cursor |
string | yes | cursor of the held-events read this decision answers; an empty cursor (nothing was waiting) decides nothing |
delivery_ids |
array of string | Held delivery UUIDs to replay: at least one for mode selected, absent otherwise | |
mode |
string: all, selected, none |
yes | all replays every replayable event, selected replays delivery_ids, none replays nothing. Replayable events not replayed are recorded as declined; expired and over-limit ones as decided |
request_id |
string (uuid) | yes | UUID chosen by the client per decision; repeating it returns the first result |
DeliverIssueBody
| Field | Type | Required | Description |
|---|---|---|---|
artifacts |
array of AutomationArtifactItem |
||
idempotency_key |
string | ||
outcome |
string: success, partial, failed |
||
summary |
string |
DisconnectAgentChannelData
| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean | yes | Whether the disconnect command was accepted for dispatch |
DisconnectConnectConnectionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
actor_member_id |
string | Optional acting member UUID. The actor is always the authenticated caller: if provided it must equal the caller's member UUID (case-insensitive), otherwise the request is rejected with 403 AUTH_FORBIDDEN. Omit to use the caller. |
DmDetailItem
| Field | Type | Required | Description |
|---|---|---|---|
billing_suspended |
boolean | True when the agent peer is stopped by billing enforcement (arrears). Advisory: the DM remains writable. Omitted when unknown. | |
billing_suspension_reason |
string | The platform's reason for the stop (e.g. insufficient_credits, agent_arrears); set only alongside billing_suspended=true | |
can_send |
boolean | Whether the current user can send messages to this DM peer | |
credit_cap_reached |
boolean | True when the agent credit cap (daily or monthly) is the effective stop reason. Advisory: the DM remains writable. | |
peer_avatar_url |
string | Peer avatar URL (resolved server-side) | |
peer_display_name |
string | Peer display name (resolved server-side) | |
peer_kind |
string: human, agent, system |
Peer member kind (resolved server-side; system for System Member DMs) | |
peer_member_id |
string (uuid) | yes | Peer OrgMember/Participant UUID |
peer_status |
string: active, suspended, departed |
Peer member status (resolved server-side) | |
read_only_reason |
string: peer_suspended, peer_departed, system_dm_readonly |
Reason this DM is read-only when can_send is false |
EditMessageRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
content |
MessageContentItem |
yes | Replacement content (full MessageContent shape) |
fallback_text |
string | Replacement preview/fallback text — the short plaintext the conversation list shows for non-text messages. Omit to leave the stored value unchanged. Capped at 8192 UTF-8 bytes by the platform. | |
type |
string: UNSPECIFIED, TEXT, IMAGE, FILE, AUDIO, VIDEO, SYSTEM, AGENT_TEXT, AGENT_STRUCTURED, AGENT_CARD, AGENT_STREAM |
Replacement message kind, e.g. editing an image message into pure text so neither the bubble nor the conversation-list preview renders it as an image. Omit to leave the kind unchanged. |
EditMessageResult
| Field | Type | Required | Description |
|---|---|---|---|
change_seq |
integer (int64) | yes | Conversation change_seq this edit allocated, so the acting device can advance its change watermark and drop the realtime frame for its own change |
edited_at |
integer (int64) | yes | Edit timestamp (unix ms) |
EnsurePrivateWorkspaceRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
knowledge_base_name |
string | Name used only when the personal knowledge base is created; defaults to the Chinese-language name for "My knowledge base" | |
project_name |
string | Name used only when the personal project is created; defaults to the Chinese-language name for "My private project" |
EntitlementsDTO
| Field | Type | Required | Description |
|---|---|---|---|
agent_slots |
integer (int64) | yes | |
grant_points |
integer (int64) | yes | |
included_agents |
array of IncludedAgentDTO |
yes | |
member_limit |
integer (int64) | yes | |
trial_days |
integer (int64) | yes | |
trial_grant_points |
integer (int64) | yes |
ErrorDetail
| Field | Type | Required | Description |
|---|---|---|---|
location |
string | Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' | |
message |
string | Error message text | |
value |
any | The value at the given location |
EventBindingChangeItem
| Field | Type | Required | Description |
|---|---|---|---|
actor_member_id |
string | ||
actor_name |
string | Current Agent or trusted chat-confirming Owner display name when available; not a historical name snapshot | |
actor_service_id |
string | ||
actor_source |
string | Trusted confirmation source; conversation_confirmed for Owner-confirmed chat changes | |
actor_type |
string | yes | Authenticated source: owner, agent or system |
changes |
array of EventBindingFieldChange |
yes | |
created_at |
string (date-time) | yes | |
event_binding_id |
string (uuid) | yes | |
id |
string (uuid) | yes | |
kind |
string | yes | updated or trigger_replaced |
parent_binding_id |
string |
EventBindingFieldChange
| Field | Type | Required | Description |
|---|---|---|---|
after |
string | yes | New display value; sensitive fields use safe markers |
before |
string | yes | Previous display value; sensitive fields use safe markers |
field |
string | yes | Changed configuration field |
redacted |
boolean | yes | Values are safe markers rather than original content |
EventBindingItem
| Field | Type | Required | Description |
|---|---|---|---|
anchor_at |
string (date-time) | Interval phase anchor instant | |
completed |
boolean | yes | Whether the current single-run schedule has created its Issue and is no longer active; does not imply Issue execution success |
created_at |
string (date-time) | yes | Creation time |
created_by_member_id |
string (uuid) | Original confirming human; absent when the creator is unknown | |
cron_expr |
string | yes | 5-field cron expression |
display_status |
string | yes | Authoritative automation state: enabled, paused, needs_attention or ended |
enabled |
boolean | yes | Whether the binding is active |
held_event_count |
integer (int32) | yes | Webhook only: held events still waiting for the Owner's replay decision, expired and over-limit ones included; 0 for a reader without run history access |
id |
string (uuid) | yes | EventBinding UUID |
interval_seconds |
integer (int64) | Fixed elapsed interval in seconds | |
last_run |
EventOccurrenceItem |
Latest unified run, with the latest revision outcome | |
lead_member_id |
string (uuid) | yes | Lead agent member UUID (executor) |
next_trigger_at |
string (date-time) | yes | Next scheduled fire time for timer bindings; webhook bindings carry an internal sentinel, not a schedule |
org_id |
string (uuid) | yes | Organization UUID |
owner_member_id |
string (uuid) | yes | Owner member UUID (human governance anchor) |
pause_reason |
string | Server-supplied pause or blocking reason | |
replaced_by_binding_id |
string (uuid) | New automation replacing this paused binding | |
replaces_binding_id |
string (uuid) | Previous automation retained when its trigger type changed | |
result_notification_policy |
string: every, failure_only, none |
yes | Final result DM policy for future runs; partial completion counts as failure |
result_notification_policy_migrated |
boolean | yes | Show the migrated webhook policy notice until the Owner explicitly writes this setting |
run_at |
string (date-time) | Once schedule trigger instant | |
schedule_kind |
string | yes | Schedule mode: cron, once or interval |
scope |
string: org, private |
yes | Scope of the automation's project: private automations are visible only to the project owner and the owner's Agents |
source_kind |
string | yes | Source kind: timer or webhook |
spec |
EventBindingSpec |
yes | Issue template applied on each fire |
timezone |
string | yes | IANA timezone; empty when no timezone is applied to the schedule |
updated_at |
string (date-time) | yes | Last update time |
version |
integer (int64) | yes | Configuration version for optimistic concurrency |
EventBindingPreview
| Field | Type | Required | Description |
|---|---|---|---|
next_trigger_at |
array of string (date-time) | yes | Upcoming scheduled trigger instants |
EventBindingRun
| Field | Type | Required | Description |
|---|---|---|---|
occurrence |
EventOccurrenceItem |
yes | Occurrence and the created Issue reference |
reused |
boolean | yes | Whether the key already identified an existing manual run |
EventBindingSpec
| Field | Type | Required | Description |
|---|---|---|---|
delivery_conversation_id |
string | Server-resolved owner and lead DM | |
description |
string | Issue description | |
knowledge_base_id |
string (uuid) | Knowledge base of the runs when knowledge_base_mode is custom | |
knowledge_base_mode |
string: project_default, custom, none |
yes | Where runs store their outputs: the project's knowledge base, knowledge_base_id, or none |
project_id |
string (uuid) | yes | Project UUID the created Issue belongs to; for an unattached automation the system project it runs in (the Inbox, or the Owner's hidden private project) |
title |
string | yes | Issue title |
unattached |
boolean | yes | The automation belongs to no project; project_id is the system project it runs in, which is never listed |
EventOccurrenceItem
| Field | Type | Required | Description |
|---|---|---|---|
approval_request_ids |
array of string | yes | Approval references on current blocked attempts; read each approval for its current decision state |
artifacts |
array of AutomationArtifactItem |
yes | Latest revision output links |
attempt_count |
integer (int32) | yes | Number of occurrence processing attempts |
created_at |
string (date-time) | yes | Occurrence record creation instant |
created_issue_id |
string (uuid) | Created issue UUID, when issue creation succeeded | |
error_code |
string | Recorded occurrence or notification error code, when present | |
event_binding_id |
string (uuid) | yes | Parent EventBinding UUID |
id |
string (uuid) | yes | Occurrence UUID |
is_partial |
boolean | yes | Successful delivery with validated partial completion |
latest_issue_id |
string (uuid) | Issue for the latest revision of this run | |
notification_status |
string | yes | Lead notification delivery status |
replay_decided_at |
string (date-time) | When the Owner decided on this held event; omitted while undecided | |
replay_state |
string: held, replay, declined, excluded, expired, overflow |
Webhook runs only: held-event replay state; omitted for a run that was never held. A replayed run keeps the received time as scheduled_at | |
result_notification_policy |
string: every, failure_only, none |
Immutable result DM policy of the latest run or revision | |
result_notification_status |
string: pending, sent, suppressed |
Final result DM status; omitted before a result, distinct from initial Lead dispatch notification_status. Delivery failures remain pending for retry | |
revision_count |
integer (int32) | yes | Number of linked revisions |
revision_issue_ids |
array of string | yes | All retained Issue versions, including the original, ordered oldest to latest |
run_reason |
string | Server-supplied interruption or blocking reason | |
run_status |
string | yes | Authoritative run state: running, awaiting_confirmation, success, interrupted or ended; ended does not assert success |
scheduled_at |
string (date-time) | yes | Scheduled trigger instant for timers; received instant for webhooks |
status |
string | yes | Occurrence processing status; not the created issue's execution outcome |
summary |
string | Latest revision delivery summary | |
trigger_kind |
string | yes | Run trigger: timer, manual or webhook |
ExecuteConnectActionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
action |
string | yes | Action name |
params |
any | Action parameters |
ExpireApprovalRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Expiry reason |
FileDownloadErrorItem
| Field | Type | Required | Description |
|---|---|---|---|
code |
string: not_found, not_a_file, no_artifact, resolve_failed |
yes | Error code |
message |
string | yes | Error message |
FileDownloadItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | yes | Artifact ID |
content_length |
integer (int64) | yes | Content length in bytes |
content_type |
string | yes | Content type |
download_url |
string | yes | Download URL: a presigned storage URL, or, when knowledge-base download tickets are enabled, a short-lived platform URL (GET /api/public/artifacts/download/{ticket}) that redirects to one |
expires_at |
string (date-time) | Download URL expiration time (the ticket expiry when download_url is a ticket URL) | |
name |
string | yes | File name |
node_id |
string (uuid) | yes | Tree node UUID |
FileDownloadResultItem
| Field | Type | Required | Description |
|---|---|---|---|
download |
FileDownloadItem |
Successful download result | |
error |
FileDownloadErrorItem |
Per-node download error | |
node_id |
string (uuid) | yes | Tree node UUID |
FilePreviewItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | yes | Artifact ID |
category |
string: image, pdf, document, code, text, unsupported |
yes | Preview category |
message |
string | yes | Preview status message |
name |
string | yes | File name |
node_id |
string (uuid) | yes | Tree node UUID |
path |
string | yes | File path |
supported |
boolean | yes | Whether preview is supported |
FinalizeAvatarUploadInputBody
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string (uuid) | yes | Prepared avatar artifact UUID |
session_id |
string (uuid) | yes | Prepared upload-session UUID |
FinalizeCommUploadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
upload_token |
string | yes | Upload token |
FinalizeUploadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
upload_token |
string | yes | Opaque upload token |
FinalizeUploadResult
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | yes | Artifact UUID |
media_id |
string | yes | Media UUID |
FindOrCreateDMRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
peer_member_id |
string (uuid) | yes | Peer OrgMember/Participant UUID |
FindOrCreateDMResult
| Field | Type | Required | Description |
|---|---|---|---|
conversation |
ConversationItem |
yes | Conversation |
created |
boolean | yes | Whether a new DM was created |
FormFieldInput
| Field | Type | Required | Description |
|---|---|---|---|
allow_other |
boolean | Choice questions only: adds an other choice the answerer can tick and describe in free text | |
description |
string | Optional explanation under the question | |
key |
string | yes | Stable question key, unique on the card; answers and the receipt are keyed by it |
label |
string | yes | The question. A text question, or a choice question that offers other, is refused when its key, label, description or placeholder names a secret (password, key, token, verification code,...). |
max_length |
integer (int32) | Text questions only: most characters (grapheme clusters) an answer takes; nothing is truncated. Omit for the platform's default, which depends on multiline. The platform holds the bounds. | |
max_select |
integer (int32) | Most choices an answered multiple question takes, a ticked other choice counting as one. Only for a choice question with selection_mode=multiple. | |
min_length |
integer (int32) | Text questions only: fewest characters (grapheme clusters) a non-empty answer takes. Omit for none. | |
min_select |
integer (int32) | Fewest choices an answered multiple question takes, a ticked other choice counting as one. Only for a choice question with selection_mode=multiple. | |
multiline |
boolean | Text questions only: a multi-line answer box. The platform caps how many a card may have. | |
options |
array of FormOptionInput |
The choices, in display order; a choice question needs them. The platform caps how many and rejects duplicate option text within a question. A text question that carries options, selection_mode, min_select, max_select or allow_other is refused. | |
placeholder |
string | Text questions only: plain-text hint shown in the empty answer box. Omit for the client's default. | |
required |
boolean | Deprecated and has no effect: every question is optional. A one-question card still has to be answered. (Deprecated) | |
selection_mode |
string | Choice questions only: single (what empty means) or multiple. The platform judges the value and how it combines with min_select, max_select and exclusive. | |
type |
string | Question type: choice (what empty means) or text, a fill-in answer. The platform refuses any other value, and refuses text while fill-in questions are switched off. |
FormGroupInput
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Set id shared by every card of the batch |
index |
integer (int32) | yes | 1-based position of this card in the set |
total |
integer (int32) | yes | Number of cards in the set |
FormInteractionInput
| Field | Type | Required | Description |
|---|---|---|---|
answerers |
array of string | Member ids of the only people who may submit. Each must be a current human member of the conversation; they are also @mentioned by the card. Omit to let any member answer. | |
blocks |
array of object | Optional context above the questions, from the same block types a choice card accepts. May be empty. | |
fields |
array of FormFieldInput |
yes | The questions, in display order. The platform caps how many. |
group |
FormGroupInput |
Marks this card as part index of total cards that together ask one batch of questions. Validated and echoed, not joined. | |
summary |
string | yes | One-line summary, also the plain-text projection for clients that cannot render the card |
title |
string | yes | Card title |
FormOptionInput
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Optional explanation under the option | |
exclusive |
boolean | Marks the none-of-these option of a multiple question: an answer that chooses it must choose nothing else, the other choice included. At most one per question. | |
key |
string | Optional stable option key, unique within the question, echoed in the receipt. The server-generated option id stays the identifier answers use. | |
label |
string | yes | Option text |
recommended |
boolean | Tags the option as recommended; nothing is preselected |
GetIntlInvoiceProfileResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
IntlInvoiceProfileDTO |
yes | The org's Bill to profile; null when never filled |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
GetMeData
| Field | Type | Required | Description |
|---|---|---|---|
auth_source |
string: sso, password |
Account origin for HUMAN identities: sso when the identity has an SSO credential binding, password otherwise. Reflects the account's registration/binding state, not how the current session logged in; binding SSO later flips it to sso. Omitted for non-human identities (agents authenticate via API keys — neither value applies) | |
avatar_url |
string | Avatar URL | |
contact_email |
string | UNVERIFIED contact email the user typed into their own profile; omitted when unset. NOT USED FOR AUTHENTICATION: no login, no verification code, no account-security mail is ever addressed to it, and no verification of it is performed or implied — there is no accompanying verified flag because the value is never verified. It exists because China-region registration collects only a phone number, so no email address is captured at sign-up and the product collects one as plain contact information. Treat it as free-text contact info, never as identity. The credential address is email. | |
created_at |
string (date-time) | yes | Identity creation time |
display_name |
string | yes | Display name |
email |
string | LOGIN email address for identities backed by an email-password account (or the SSO provider's email for SSO-only identities). This is the account's credential/verification address: it is what account-security flows such as the organization self-service deletion verification code are sent to. Not user-editable through this API. NOT the same value as contact_email — do not read one when you mean the other. | |
identity_id |
string (uuid) | yes | The authenticated identity's UUID |
kind |
string: human, agent |
yes | Identity type |
locale |
string: en, zh |
Identity-level preferred language; omitted when unset (recipients then fall back to en) | |
member_id |
string (uuid) | Member ID within the current org | |
member_kind |
string: human, agent |
Member type in the current org | |
org_id |
string (uuid) | Current organization ID (present when JWT is org-scoped) | |
org_name |
string | Current organization name | |
org_slug |
string | Current organization slug | |
phone_cc |
string | Primary phone country calling code (digits only, no +); omitted when unset | |
phone_number |
string | Primary phone national number (without country code); omitted when unset | |
role |
GetMeRoleItem |
Role assigned in the current org (omitted for identity-only JWT) |
GetMeRoleItem
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Role display name |
scope |
string: org |
yes | Role scope |
scope_id |
string (uuid) | Scoped entity ID (org ID) | |
slug |
string | yes | Role slug (e.g. org-owner, org-admin, org-member) |
GetMemberResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_origin |
string: platform_created, external_invited |
Agent membership origin; omitted for non-agent members | |
agent_readiness |
string: provisioning, ready |
Platform agent provisioning readiness. 'provisioning' = creation still in flight, hold chat entry; 'ready' = has proved alive. OMITTED means the member is not subject to the provisioning gate — treat absent as not gated, never as not ready. | |
agent_type |
string | Agent runtime type (e.g. hermes, claude_code); omitted for non-agent members | |
avatar_url |
string | Avatar URL | |
created_at |
string (date-time) | yes | Record creation time |
creator_member_id |
string (uuid) | Creator member ID (for agent members, immutable) | |
display_name |
string | yes | Display name |
email |
string | Email address (human members only) | |
identity_id |
string (uuid) | yes | Identity UUID |
joined_at |
string (date-time) | yes | When the member joined the org |
kind |
string: human, agent, system |
yes | Member type |
locale |
string: en, zh |
Identity-level preferred language; omitted when unset (fallback: en) | |
member_id |
string (uuid) | yes | Member UUID |
online_status |
string: online, offline, unknown |
Online status (unknown if it cannot be determined) | |
operational_state |
PlatformAgentOperationalStateDTO |
||
operational_state_availability |
string: available, unavailable, not_applicable |
Availability of the authoritative billing control state; runtime observation is independent | |
owner_member_id |
string (uuid) | Owner member ID (for agent members) | |
request_id |
string (uuid) | yes | Request trace ID |
role |
MemberRole |
yes | Assigned role (single-role model) |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: active, suspended, departed |
yes | Member status |
subsystem_key |
string: approval_center, scheduler, notification_center, interaction_center |
Platform subsystem key (system members only); stable key for client-side name localization |
GetMessageResult
| Field | Type | Required | Description |
|---|---|---|---|
content |
MessageContentItem |
Expanded content | |
inbox_seq |
integer (int64) | Caller's own inbox sequence for this message (per-user); omitted when the caller has no inbox entry | |
message |
MessageItem |
yes | Message |
GetPolicyChangeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
applied_at |
string (date-time) | When an agent report confirmed the change (for a batch: its last item); absent while unconfirmed | |
change_id |
string | yes | Policy change ID |
created_at |
string (date-time) | yes | When the web edit was accepted |
item |
string | yes | Changed setting: batch (an update-agent-policy batch; see items) | group_mode:{conversation_id} | group_allow_from:{conversation_id} |
items |
array of string | Batch only: the items of the batch (dm_policy | dm_allowlist | group_scope | group_allowlist), in that fixed order; absent for a per-group change | |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: applying, applied, failed |
yes | applied once an agent report carried the requested value; applying for the first 30 seconds; failed after that (a late report can still turn it applied) |
GetPolicyResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
dm_allowlist |
array of string | yes | Member UUIDs in the DM allowlist |
dm_policy |
string | yes | DM access policy |
group_allowlist |
array of string | yes | Conversation UUIDs in the group allowlist |
group_allowlist_names |
object | Conversation UUID to display name mapping for group allowlist entries | |
group_scope |
string | yes | Group access scope |
groups |
array of AgentGroupPolicyItem |
yes | Per-group policy settings |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
updated_at |
integer (int64) | yes | Last policy update timestamp (unix seconds) |
GroupDetailItem
| Field | Type | Required | Description |
|---|---|---|---|
admin_count |
integer (int32) | yes | Admin count |
description |
string | yes | Group description |
HeldWebhookEventItem
| Field | Type | Required | Description |
|---|---|---|---|
cause |
string: paused, org_suspended |
yes | Why the event was held: the automation was paused, or the organization was suspended |
delivery_id |
string (uuid) | yes | Held webhook delivery UUID |
received_at |
string (date-time) | yes | When the event was received |
summary |
string | yes | Event type and title from common GitLab/GitHub fields, else the first 120 characters of the event JSON. Untrusted sender text |
HeldWebhookEvents
| Field | Type | Required | Description |
|---|---|---|---|
cursor |
string | yes | Opaque. Pass it to the decision: only events listed up to this read are decided. Empty when nothing is waiting for a decision |
expired |
integer (int32) | yes | Held events whose content expired with the payload retention; cannot be replayed |
items |
array of HeldWebhookEventItem |
yes | Replayable events (matching the current filter), oldest first, at most 200 |
lead_paused |
boolean | yes | The Lead Agent is suspended: replayed runs start after it is resumed |
org_suspended |
boolean | yes | The organization is suspended: a decision answers 409 WORK_ORG_SUSPENDED |
overflow |
integer (int32) | yes | Events past the per-automation hold limit, kept without content; cannot be replayed |
replayable |
integer (int32) | yes | Held events that match the current filter and can be replayed |
HeldWebhookEventsDecision
| Field | Type | Required | Description |
|---|---|---|---|
decision_id |
string (uuid) | yes | Replay decision UUID |
declined |
integer (int32) | yes | Replayable events not replayed |
excluded |
integer (int32) | yes | Held events that no longer match the current filter |
expired |
integer (int32) | yes | Expired events marked as decided |
mode |
string: all, selected, none |
yes | Decided mode |
overflow |
integer (int32) | yes | Over-limit events marked as decided |
replayed |
integer (int32) | yes | Events queued for replay; their Issues are created in received order about 3 seconds apart and consume credits |
reused |
boolean | yes | request_id was decided before and this is the stored result |
InboxStatusResult
| Field | Type | Required | Description |
|---|---|---|---|
last_delivered_seq |
integer (int64) | yes | Highest sync sequence already delivered to the caller |
max_seq |
integer (int64) | yes | Highest sync sequence currently available for the caller's inbox |
IncludedAgentDTO
| Field | Type | Required | Description |
|---|---|---|---|
count |
integer (int32) | yes | |
tier |
string | yes |
InflightOrderDTO
| Field | Type | Required | Description |
|---|---|---|---|
biz_order_id |
string | yes | |
can_cancel |
boolean | yes | Whether this exact in-flight order may be synchronously canceled and replaced |
status |
string | yes |
InitOrgKBData
| Field | Type | Required | Description |
|---|---|---|---|
org_id |
string (uuid) | yes | Organization UUID |
status |
string | yes | Initialization status |
InstallmentItemDTO
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string (date-time) | ||
grant_id |
integer (int64) | 0 = not granted yet | |
month_index |
integer (int32) | yes | 1-based period index within the purchase |
points |
integer (int64) | null = not yet determined; read together with points_projected. NOT collapsed to 0. | |
points_projected |
boolean | yes | true = points is a projection, not a settled fact |
scheduled_at |
string (date-time) | ||
status |
string | yes |
InstallmentScheduleDTO
| Field | Type | Required | Description |
|---|---|---|---|
billing_interval |
string | ||
biz_order_id |
string | yes | |
granted_installments |
integer (int32) | yes | |
installments |
array of InstallmentItemDTO |
yes | |
order_status |
string | yes | |
order_type |
string | yes | |
paid_at |
string (date-time) | ||
plan_code |
string | ||
total_installments |
integer (int32) | yes |
InteractionRequestResult
| Field | Type | Required | Description |
|---|---|---|---|
action_ids |
array of string | yes | Server-generated ids of the options, in the order they were supplied. Empty for a form card, whose ids are in form_option_ids. |
created_at |
string (date-time) | yes | When the card was sent |
form_option_ids |
object | Form cards only: question key to the server-generated ids of that question's options, in card order; a text question maps to an empty list | |
message_id |
string | yes | The card message that was sent |
seq |
integer (int64) | yes | Conversation sequence number of the card |
InterruptAgentRuntimeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentRuntimeCommandResult |
yes | Accepted runtime command result |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
IntlInvoiceProfileDTO
| Field | Type | Required | Description |
|---|---|---|---|
address |
string | Bill to address, newlines kept; absent when not filled | |
company |
string | Bill to company; absent when not filled | |
email |
string | yes | Bill to email |
name |
string | yes | Bill to name |
updated_at |
string (date-time) | Last saved at |
InvitationSummary
| Field | Type | Required | Description |
|---|---|---|---|
accepted_at |
string (date-time) | When the invitation was accepted | |
created_at |
string (date-time) | yes | Invitation creation time |
display_name |
string | yes | Invitee's org-level member display name |
email |
string | Invitee email (null for agent invitations) | |
expires_at |
string (date-time) | yes | Invitation expiry |
invitation_id |
string (uuid) | yes | Invitation UUID |
invited_by_member_id |
string (uuid) | yes | Member who sent the invitation |
role_slug |
string | yes | Assigned role slug |
status |
string: pending, accepted, revoked, expired |
yes | Invitation status |
InvoiceApplicationDTO
| Field | Type | Required | Description |
|---|---|---|---|
application_no |
string | yes | The billing system's own user-visible application number (not the legal invoice number) |
buyer_address |
string | Buyer's address; company_special (special VAT fapiao) only | |
buyer_bank_account |
string | Buyer's bank account number; company_special (special VAT fapiao) only | |
buyer_bank_name |
string | Buyer's bank name; company_special (special VAT fapiao) only | |
buyer_email |
string | ||
buyer_name |
string | yes | |
buyer_tax_id |
string | Empty for personal normal invoices | |
buyer_tel |
string | Buyer's phone number; company_special (special VAT fapiao) only | |
created_at |
string (date-time) | ||
currency |
string | yes | |
failure_code |
string | ||
failure_message |
string | ||
id |
integer (int64) | yes | |
invoice_no |
string | Legal invoice number (set after issuance) | |
invoice_type |
string | yes | personal_normal|company_normal|company_special |
issued_at |
string (date-time) | ||
ofd_url |
string | ||
order_ids |
array of string | yes | Business order ids this application covers |
orders |
array of InvoiceOrderLineDTO |
Per-order lines for the detail view's related-orders table (order number, type, invoiceable amount, payment time); detail read path only | |
pdf_url |
string | ||
red_buyer_confirmation_status |
string | Buyer confirmation status of the red-letter confirmation, as the tax-invoice provider's raw status text (Chinese display text, not a normalized enum: pending confirmation, confirmed, rejected or timed out); empty when not yet known | |
red_confirmation_deadline_at |
string (date-time) | ||
red_confirmation_no |
string | ||
status |
string | yes | payment_create_pending|issuing|issued|failed|voiding|voided |
tax_amount_minor |
integer (int64) | yes | Tax amount in currency minor units; 0 until issued |
total_amount_minor |
integer (int64) | yes | Invoice total in currency minor units (CNY fen) |
void_reason |
string | ||
void_requested_at |
string (date-time) |
InvoiceArtifactDTO
| Field | Type | Required | Description |
|---|---|---|---|
invoice_no |
string | yes | Legal invoice number |
ofd_url |
string | ||
pdf_url |
string |
InvoiceHistoryDTO
| Field | Type | Required | Description |
|---|---|---|---|
auto_topup |
boolean | true when the credit_pack was bought by auto top-up | |
billing_interval |
string | month|quarter|year for a plan-class order; empty for credit_pack | |
credit_points |
integer (int64) | Credits bought by a credit_pack order; 0 for other order types | |
currency |
string | Order settlement currency (USD|CNY) | |
invoice_no |
string | yes | |
issued_at |
string (date-time) | ||
line_items |
array of InvoiceLineItemDTO |
yes | |
order_invoice_status |
string | Per-order domestic-invoice status (invoiceable|issuing|issued), derived from CN invoice occupancy/applications; empty on orders with no CN invoice track (e.g. USD orders) | |
order_type |
string | subscription|renewal|plan_change|credit_pack | |
payment_method |
string | card|wechat|alipay; may be empty when the method is not known | |
period_end |
string (date-time) | ||
period_start |
string (date-time) | ||
plan_code |
string | Plan code of a plan-class order (subscription|renewal|plan_change); empty for credit_pack | |
provider_receipt_url |
string | ||
refunded_amount_cents |
integer (int64) | Cumulative refunded amount in currency minor units. Absent = not known (the refund read failed or is not performed), and clients show no refund label; present (including 0) = known | |
tax_cents |
integer (int64) | yes | |
total_cents |
integer (int64) | yes |
InvoiceLineItemDTO
| Field | Type | Required | Description |
|---|---|---|---|
amount_cents |
integer (int64) | yes | |
desc |
string | yes | |
qty |
integer (int64) | yes | |
unit_cents |
integer (int64) | yes |
InvoiceOrderLineDTO
| Field | Type | Required | Description |
|---|---|---|---|
biz_order_id |
string | yes | |
currency |
string | yes | |
order_type |
string | yes | subscription|renewal|plan_change|credit_pack |
paid_amount_minor |
integer (int64) | yes | Order paid amount in currency minor units (CNY fen) |
paid_at |
string (date-time) | ||
target_ref |
string | plan_code (subscription/renewal/plan_change) or product code (credit_pack) |
InvoiceSummaryDTO
| Field | Type | Required | Description |
|---|---|---|---|
currency |
string | Settlement currency of the amounts (CNY); empty when the org has no domestic-invoiceable orders | |
issued_minor |
integer (int64) | yes | Sum of already-issued order amounts in currency minor units (CNY fen) |
remaining_invoiceable_minor |
integer (int64) | yes | Sum of still-invoiceable order amounts in currency minor units (CNY fen) |
InvoiceableOrderDTO
| Field | Type | Required | Description |
|---|---|---|---|
application_id |
integer (int64) | Linked invoice application id; 0 when the order has no application yet (invoiceable) | |
biz_order_id |
string | yes | |
currency |
string | yes | |
invoiceable_status |
string | yes | invoiceable|issuing|issued |
order_type |
string | yes | subscription|renewal|plan_change|credit_pack |
paid_amount_minor |
integer (int64) | yes | Paid amount in currency minor units (CNY fen) |
paid_at |
string (date-time) | ||
target_ref |
string | plan_code (subscription/renewal/plan_change) or product code (credit_pack) |
IssueItem
| Field | Type | Required | Description |
|---|---|---|---|
acceptance_source |
string: im, explicit, text_card_proxy, auto |
Acceptance source; auto does not represent human approval | |
accepted_at |
string (date-time) | Acceptance time | |
archived_at |
string (date-time) | Archive time | |
automation_policy |
string | Server-owned automatic workflow policy; silent for new automation runs | |
automation_root_issue_id |
string | Original automation run issue for linked revisions | |
created_at |
string (date-time) | yes | Creation time |
current_blueprint_id |
string (uuid) | Current blueprint UUID | |
current_plan_text |
string | Exact submitted plan text; absent when no plan text was saved (for example for a silent automation) | |
current_plan_token |
string | Opaque ordinary plan submission token used to guard human decisions | |
delivery |
AutomationDeliveryItem |
Persisted result and independent notification state | |
description |
string | yes | Issue description |
id |
string (uuid) | yes | Issue UUID |
is_automation |
boolean | yes | Server-verified automation origin; does not grant silent execution or bypass human acceptance |
knowledge_base_id |
string (uuid) | yes | Knowledge base captured when the issue was created; unaffected by project default changes |
lead_agent_id |
string (uuid) | Lead agent UUID | |
lead_agent_status |
string: active, suspended, departed |
Current membership status of the lead member | |
org_id |
string (uuid) | yes | Organization UUID |
origin_conversation_id |
string (uuid) | Origin conversation UUID | |
origin_message_id |
string | Origin message identifier; message identifiers may be decimal strings | |
owner_member_id |
string (uuid) | yes | Issue owner member UUID; only this member can accept delivered work |
priority |
string: low, medium, high |
yes | Issue priority |
project_id |
string (uuid) | yes | Project UUID |
result_notification_policy |
string: every, failure_only, none |
Immutable result DM policy captured for this automation run | |
status |
string: backlog, in_progress, pending_plan, delivered, accepted, terminated |
yes | Issue status |
terminated_at |
string (date-time) | Early-termination time | |
termination_reason |
string | Early-termination reason | |
title |
string | yes | Issue title |
updated_at |
string (date-time) | yes | Last update time |
JWK
| Field | Type | Required | Description |
|---|---|---|---|
alg |
string | yes | |
e |
string | yes | |
kid |
string | yes | |
kty |
string | yes | |
n |
string | yes | |
use |
string | yes |
JWKSet
| Field | Type | Required | Description |
|---|---|---|---|
keys |
array of JWK |
yes |
KbItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
creator_id |
string | yes | Creator principal ID |
creator_type |
string: user, agent, team, system |
yes | Creator entity type |
description |
string | KB description | |
icon |
string | KB icon | |
id |
string (uuid) | yes | KB UUID |
is_default |
boolean | yes | Whether this is the default KB |
is_personal |
boolean | yes | Whether this is the owner's personal knowledge base (created by POST /api/v1/me/private-workspace) |
name |
string | yes | KB name |
org_id |
string (uuid) | yes | Organization UUID |
owner_member_id |
string (uuid) | Owner of a private knowledge base; only the owner and the owner's Agents can see it | |
status |
string: active, archived, trashed |
yes | KB status |
storage_quota_bytes |
integer (int64) | yes | Storage quota in bytes |
trashed_at |
string (date-time) | Trash time | |
updated_at |
string (date-time) | yes | Last update time |
visibility |
string: open, closed, private |
yes | KB visibility |
KbSummaryItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
creator_id |
string | yes | Creator principal ID |
creator_type |
string: user, agent, team, system |
yes | Creator entity type |
description |
string | KB description | |
icon |
string | KB icon | |
id |
string (uuid) | yes | KB UUID |
is_default |
boolean | yes | Whether this is the default KB |
is_personal |
boolean | yes | Whether this is the owner's personal knowledge base |
last_modified_at |
string (date-time) | Last content modification time | |
name |
string | yes | KB name |
org_id |
string (uuid) | yes | Organization UUID |
owner_member_id |
string (uuid) | Owner of a private knowledge base; only the owner and the owner's Agents can see it | |
page_count |
integer (int64) | yes | Page count |
status |
string: active, archived, trashed |
yes | KB status |
updated_at |
string (date-time) | yes | Last update time |
visibility |
string: open, closed, private |
yes | KB visibility |
LastMessagePreviewItem
| Field | Type | Required | Description |
|---|---|---|---|
content |
string | Message content | |
edited_at |
integer (int64) | Edit timestamp | |
fallback_text |
string | Fallback text preview | |
id |
integer (int64) | yes | Message ID |
sender_id |
string | yes | Sender member ID |
sender_type |
string | yes | Sender type (human/agent/system) |
timestamp |
integer (int64) | yes | Message timestamp (unix ms) |
type |
string | yes | Message type (text/image/file/...) |
LeaveGroupRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
new_owner_id |
string (uuid) | When the leaving member is the group owner, the human member to hand ownership to. Omit to let the platform pick a random remaining human member, or delete the group when only agents/nobody remain. |
LeaveGroupResult
| Field | Type | Required | Description |
|---|---|---|---|
conversation_deleted |
boolean | yes | True when the leave deleted the group (owner left with no human members remaining). |
new_owner_id |
string | The member the ownership was transferred to, when the leaving member was the owner. |
ListAgentKnowledgeBasesResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of KbSummaryItem |
yes | Knowledge bases the Agent can read and the caller can read too |
hidden_count |
integer (int32) | yes | Knowledge bases the Agent can read but the caller cannot; only counted, never listed |
pagination |
CursorMetadata |
yes | Pagination metadata; total_count excludes hidden_count |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ListInvoiceableOrdersResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of InvoiceableOrderDTO |
yes | Response payload |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ListInvoicesResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of InvoiceHistoryDTO |
yes | Response payload |
intl_invoice_enabled |
boolean | yes | Effective international self-issued invoice switch (a deployment setting; off by default, always false on the China edition). While false, clients keep the billing list unchanged (as before international invoices) and ignore the international-invoice list fields |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ListMessageEditsResult
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of MessageEditItem |
yes | Archived pre-edit revisions, oldest first |
ListMessagesPagination
| Field | Type | Required | Description |
|---|---|---|---|
newer_cursor |
string | Continue toward NEWER messages: pass this value as after_seq. Only returned for around_seq windows, and only when a newer message exists; absent otherwise. | |
next_cursor |
string | yes | Continue toward OLDER messages: pass this value as before_seq. Empty string when no older message exists. |
total_count |
integer (int64) | Total number of matching items; omitted when the service does not compute a total |
ListMessagesResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
anchor_found |
boolean | around_seq windows only: whether the anchor message itself still exists. A recalled message still exists (it is returned as a tombstone), so it reports true. False for a hard-deleted anchor (anchor_seq set, data holds its neighborhood) and for an around_seq that is not a position (anchor_seq absent, data holds the latest window, which is empty only for an empty conversation). | |
anchor_seq |
integer (int64) | around_seq windows only: the seq the window is centered on. Present whenever that position exists in the conversation, including when the anchor message itself was hard-deleted. Absent when around_seq is not a position in this conversation (past its newest message); the window then falls back to the latest messages. Absence does not mean data is empty. | |
data |
array of MessageItem |
yes | Response payload |
head_change_seq |
integer (int64) | yes | The conversation's change-log head as of this response's data (including its reactions and card state). A client initializing its change watermark from this response has seen exactly the changes 1..head_change_seq; continue with list-conversation-changes since_change_seq=head_change_seq. 0 when the conversation has no change yet. |
pagination |
ListMessagesPagination |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ListMyInvitationsData
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of MyInvitationItem |
yes | At most one invitation per organization (the newest), newest first. Empty when nothing is addressed to the caller's verified login emails. |
ListOrdersResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
current_inflight_plan_change |
InflightOrderDTO |
Order that holds the current plan-change single-flight slot, as selected by the billing system | |
data |
array of OrderHistoryDTO |
yes | Response payload |
pagination |
BillingPageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
MarkMentionsReadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
message_ids |
array of string | yes | Message ids whose @mention the caller has read. An empty list is a valid no-op. A non-numeric id is rejected outright rather than skipped, so the reported count can never be smaller than what the caller asked for. |
MarkMentionsReadResult
| Field | Type | Required | Description |
|---|---|---|---|
marked |
integer (int64) | yes | How many mentions this call actually flipped to read. Lower than the request when some were already read — the call is idempotent, not an error. |
MarkReadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
read_until_seq |
integer (int64) | yes | Read until sequence |
MarkReadResult
| Field | Type | Required | Description |
|---|---|---|---|
read_until_seq |
integer (int64) | yes | Read until sequence |
MemberBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | Stable error code when this member could not be removed | |
member_id |
string (uuid) | yes | Member UUID |
message |
string | Human-readable reason when this member could not be removed | |
status |
integer (int64) | yes | HTTP-equivalent status for this member |
success |
boolean | yes | Whether this member's removal was accepted. Read status to know whether it finished: 204 means the member is gone, 202 means the billing system accepted a platform Agent's teardown and the member is still there holding its slot. Counting success alone overstates how many seats or slots were freed. |
MemberBatchSummary
| Field | Type | Required | Description |
|---|---|---|---|
duplicates |
integer (int64) | yes | Duplicate member IDs skipped before execution |
failed |
integer (int64) | yes | Number of members that could not be removed |
invalid |
integer (int64) | yes | Blank member IDs skipped before execution |
pending |
integer (int64) | yes | Number of platform Agents whose teardown the billing system accepted but has not finished; they are still members and still hold their agent slot |
success |
integer (int64) | yes | Number of members removed |
total |
integer (int64) | yes | Number of member IDs in the request |
unique_total |
integer (int64) | yes | Unique non-blank member IDs processed |
MemberDisplayInfo
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL | |
deleted |
boolean | yes | True when the member has been removed from the organization. Its name is returned so historical reports can label it; it is no longer a member. |
deleted_at |
string (date-time) | When the member was removed; present only when deleted is true | |
display_name |
string | yes | Last-known display name |
kind |
string: human, agent, system |
yes | Member type |
member_id |
string (uuid) | yes | Member UUID |
owner_member_id |
string (uuid) | Owner member ID (for agent members) | |
status |
string: active, suspended, departed |
yes | Last-known member status. Presentation only — do not gate access on it. |
MemberRole
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Human-readable role name |
slug |
string | yes | Role slug (e.g. org-owner, org-admin, org-member) |
MemberSummary
| Field | Type | Required | Description |
|---|---|---|---|
agent_origin |
string: platform_created, external_invited |
Agent membership origin; omitted for non-agent members | |
agent_readiness |
string: provisioning, ready |
Platform agent provisioning readiness. 'provisioning' = creation still in flight, hold chat entry; 'ready' = has proved alive. OMITTED means the member is not subject to the provisioning gate — treat absent as not gated, never as not ready. | |
agent_type |
string | Agent runtime type (e.g. hermes, claude_code); omitted for non-agent members | |
avatar_url |
string | Avatar URL | |
billing_suspended |
boolean | True when the agent is stopped by billing enforcement (arrears); false otherwise, including a credit-cap stop (see credit_cap_reached). Omitted when unknown. | |
billing_suspension_reason |
string | Why billing stopped the agent, as reported by billing (e.g. insufficient_credits, agent_arrears). Omitted when not suspended or unknown. | |
credit_cap_reached |
boolean | True when the effective stop reason is the agent credit cap (daily or monthly). Independent cap details are available from billing; omitted when not capped, unknown, or another restriction has priority. | |
display_name |
string | yes | Display name |
email |
string | Email address (human members only) | |
identity_id |
string (uuid) | yes | Identity UUID |
joined_at |
string (date-time) | yes | When the member joined the org |
kind |
string: human, agent, system |
yes | Member type |
locale |
string: en, zh |
Identity-level preferred language; omitted when unset (fallback: en) | |
member_id |
string (uuid) | yes | Member UUID |
online_status |
string: online, offline, unknown |
Online status (unknown if it cannot be determined) | |
owner_member_id |
string (uuid) | Owner member ID (for agent members) | |
role |
MemberRole |
yes | Assigned role (single-role model) |
status |
string: active, suspended, departed |
yes | Member status |
subsystem_key |
string: approval_center, scheduler, notification_center, interaction_center |
Platform subsystem key (system members only); stable key for client-side name localization |
MentionDisplayItem
| Field | Type | Required | Description |
|---|---|---|---|
is_mention_all |
boolean | yes | Whether this mention came from @all/@all_agents expansion rather than a direct mention |
mentioned_id |
string (uuid) | yes | Mentioned member UUID |
username |
string | Display name captured at mention time (may be stale) |
MentionInput
| Field | Type | Required | Description |
|---|---|---|---|
member_id |
string (uuid) | Mentioned member UUID; required when type is member, ignored otherwise | |
type |
string: member, all, all_agents |
yes | Mention target type |
MentionQueueEntryItem
| Field | Type | Required | Description |
|---|---|---|---|
is_mention_all |
boolean | yes | false = named directly (@me); true = swept up by an @all expansion |
message_id |
string | yes | Message the @mention points at (string: the id is a BIGINT and must not become a JSON number) |
sender_id |
string | yes | Member id of whoever sent the mentioning message |
sender_type |
string | yes | Sender kind (human / agent / system) |
seq |
integer (int64) | yes | Conversation sequence of the mentioning message; the queue is ordered by this, not by timestamp |
timestamp |
string (date-time) | yes | Message timestamp, for display only |
MentionQueueResult
| Field | Type | Required | Description |
|---|---|---|---|
mentions |
array of MentionQueueEntryItem |
yes | Unread @mentions, oldest first (by seq). May be shorter than the totals below when the page limit cuts in. |
total_all |
integer (int64) | yes | Unread @all mentions BEFORE the page limit. Kept separate from total_me because the button shows the count for the current type. |
total_me |
integer (int64) | yes | Unread direct (@me) mentions BEFORE the page limit. Render the badge from this, never from mentions.length. |
MessageContentItem
| Field | Type | Required | Description |
|---|---|---|---|
attachments |
array of AttachmentItem |
Attachments | |
body |
object | yes | Structured content body |
content_type |
string | yes | Content type, e.g. text, rich_text, image, file |
token_usage |
TokenUsageItem |
Token usage |
MessageEditItem
| Field | Type | Required | Description |
|---|---|---|---|
attachments |
array of AttachmentItem |
Archived attachments | |
body |
object | yes | Archived content body |
content_type |
string | yes | Content type of the archived revision |
created_at |
integer (int64) | yes | When the edit happened (unix ms) |
edited_by |
string | yes | Member UUID that performed the edit |
id |
string | yes | Edit record UUID |
message_id |
string | yes | Message UUID |
version |
integer (int32) | yes | content_version the archived revision carried |
MessageHighlight
| Field | Type | Required | Description |
|---|---|---|---|
field |
string | yes | Matched field name |
snippet |
string | yes | Snippet with HTML em tags for highlighting; clients must escape when rendering to DOM |
MessageItem
| Field | Type | Required | Description |
|---|---|---|---|
agent_run |
object | Opaque agent run summary (agent execution visibility, schema_version 2) passed through from the stored message's agent_run. Producer-defined JSON object: render generically and ignore unknown keys. Present only on agent messages that carried one; omitted when absent and always omitted on recalled or deleted messages | |
attachments |
array of AttachmentItem |
Message attachments (image/file metadata) | |
card_body |
object | The full card body in the cws.card.v1 card format (cws.card.v1 is the format identifier). A message list page may return card_preview with card_truncated=true instead; get the message to read card_body. Never present together with card_preview | |
card_expired |
boolean | Whether the card interaction window expired; registered automation cards use their 24-hour consent window | |
card_preview |
object | A shortened card in the cws.card.preview.v1 format (the format identifier) that a message list page may return instead of card_body, with card_truncated=true. It carries no kind=operation action; get the message for the full card | |
card_state |
CardStateItem |
Latest settled interaction on this card; absent when nobody has acted on it | |
card_superseded |
boolean | Whether a later card replaces this one, including server-registered automation revisions | |
card_truncated |
boolean | Whether card_preview was returned in place of card_body | |
chat_history_preview |
object | CHAT_HISTORY messages only: a preview of a merged forward in the cws.chat_history.preview.v1 format (the format identifier): title, record_count and the first records, shortened. The full record list is content.body of get-message. Absent for every other type and for recalled messages. | |
client_msg_id |
string | Sender-provided idempotency key, echoed on reads (optimistic reconciliation) | |
content |
string | Raw JSON message content | |
content_version |
integer (int32) | yes | Content version |
conversation_id |
string (uuid) | yes | Conversation UUID |
created_at |
string (date-time) | yes | Creation time |
deleted_at |
string (date-time) | Delete timestamp | |
edited_at |
string (date-time) | Edit timestamp | |
fallback_text |
string | Fallback text | |
id |
string | yes | Message UUID |
mentions |
array of MentionDisplayItem |
Mentions stored with the message, for rendering @-chips; omitted when the message has no mentions | |
metadata |
object | Opaque message metadata passthrough; omitted when absent | |
org_id |
string (uuid) | yes | Organization UUID |
parent_id |
string | Parent message ID (reply target) | |
priority |
integer (int32) | yes | Message priority (1=urgent, 2=high, 3=normal); stamped server-side, always present |
reactions |
array of ReactionAggregate |
Per-code reaction rollups; omitted when the message has no reactions | |
recalled_by |
string (uuid) | Member UUID that recalled the message; presence marks the message as recalled (its content is redacted) | |
recalled_by_role |
string: sender, admin |
Whether the recall was performed by the original sender or a conversation admin/owner | |
sender_id |
string (uuid) | yes | Sender member UUID |
sender_type |
string: UNSPECIFIED, HUMAN, AGENT, SYSTEM |
yes | Sender type |
seq |
integer (int64) | yes | Conversation sequence |
timestamp |
string (date-time) | yes | Message timestamp |
type |
string: UNSPECIFIED, TEXT, IMAGE, FILE, AUDIO, VIDEO, SYSTEM, AGENT_TEXT, AGENT_STRUCTURED, AGENT_CARD, AGENT_STREAM, CARD … |
yes | Message type |
MessageSearchHitItem
| Field | Type | Required | Description |
|---|---|---|---|
highlights |
array of MessageHighlight |
Highlighted snippets | |
message |
MessageItem |
yes | Matched message |
score |
number (float) | yes | Relevance score |
ModelCatalogData
| Field | Type | Required | Description |
|---|---|---|---|
models |
array of ModelCatalogEntry |
yes | Available models ordered by sort |
ModelCatalogEntry
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Human-readable model name for UI display |
family |
string | yes | Stable model-family key used for selection and persistence (e.g. fable, opus, sonnet) |
internal_only |
boolean | When true, the model is restricted to admin operations and hidden from customer-facing interfaces | |
sort |
integer (int64) | yes | Display order (ascending) |
MoveIssueProjectRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
new_project_id |
string (uuid) | yes | New project UUID |
MoveNodeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
parent_id |
string (uuid) | New parent node UUID |
MyInvitationItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Invitation creation time |
expires_at |
string (date-time) | yes | Invitation expiry |
invitation_id |
string (uuid) | yes | Invitation UUID; pass it to POST /api/v1/me/invitations/{invitation_id}/accept |
inviter_display_name |
string | yes | Current member display name of whoever sent the invitation (also shown after they left the organization) |
org_id |
string (uuid) | yes | Inviting organization |
org_name |
string | yes | Current name of the inviting organization |
MyProvisioningAgentSummary
| Field | Type | Required | Description |
|---|---|---|---|
agent_provisioning_stage |
string: runtime_down, runtime_up, session_ready, ready |
Provisioning-progress rung for the creation animation. On THIS endpoint it is 'ready' if and only if the agent is ready: a just-ready agent reports 'ready' even before its runtime does, and a still-provisioning agent never reports 'ready' early, even if its runtime does. So a client may key the completion frame off stage=='ready' here. Omitted when a still-provisioning agent has no reported stage. | |
avatar_url |
string | Avatar URL | |
display_name |
string | yes | Display name |
member_id |
string (uuid) | yes | Agent member UUID (drill-down target) |
ObservationEdge
| Field | Type | Required | Description |
|---|---|---|---|
granted_at |
string (date-time) | yes | When observation was granted |
granted_by |
string | yes | Grant source |
observed_member_id |
string (uuid) | yes | Observed member UUID |
observer_member_id |
string (uuid) | yes | Observer member UUID |
org_id |
string (uuid) | yes | Organization UUID |
ObservationMember
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL | |
display_name |
string | yes | Display name |
kind |
string: human, agent |
yes | Member type |
member_id |
string (uuid) | yes | Member UUID |
status |
string: active, suspended, departed |
yes | Member status |
ObservedMemberItem
| Field | Type | Required | Description |
|---|---|---|---|
member |
ObservationMember |
yes | Observed member detail |
observation |
ObservationEdge |
yes | Observation edge metadata |
ObserverMemberItem
| Field | Type | Required | Description |
|---|---|---|---|
member |
ObservationMember |
yes | Observer member detail |
observation |
ObservationEdge |
yes | Observation edge metadata |
OrderCheckoutDTO
| Field | Type | Required | Description |
|---|---|---|---|
checkout_type |
string | redirect (default; empty means redirect) | qr_code (checkout_url is QR content, render it) | jsapi (checkout_url is JSAPI params, do not navigate) | |
checkout_url |
string | Cashier URL to resume payment; non-empty only when status=pending_payment and the handle is still live | |
payment_order_id |
string | ||
status |
string | yes | pending_payment (checkout_url live) | expired (handle dead — cancel the order and create a new one) | the order's current status otherwise |
OrderFateDTO
| Field | Type | Required | Description |
|---|---|---|---|
biz_order_id |
string | yes | |
created_at |
string (date-time) | ||
failure_code |
string | Set when status is a failed terminal state | |
order_type |
string | yes | subscription|renewal|plan_change|credit_pack|agent_addon (agent_addon: an agent add-on purchase — its status carries the add-on lifecycle vocabulary, not the fiat-order one) |
status |
string | yes | |
updated_at |
string (date-time) |
OrderHistoryDTO
| Field | Type | Required | Description |
|---|---|---|---|
amount_cents |
integer (int64) | yes | |
billing_interval |
string | Plan orders only | |
biz_order_id |
string | yes | |
coupon_applied |
string | ||
currency |
string | yes | |
paid_at |
string (date-time) | ||
provider_receipt_url |
string | ||
sku_code |
string | Product sku the order was placed for (e.g. the credit-pack sku); lets a client match a pending order back to the selected item | |
status |
string | yes | |
type |
string | yes | subscription|renewal|plan_change|credit_pack |
OrgOwnerInfo
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Owner display name |
member_id |
string (uuid) | yes | Owner member UUID |
OrganizationDeletionImpactDTO
| Field | Type | Required | Description |
|---|---|---|---|
category |
string | yes | Data category the participant counted |
count |
integer (int64) | yes | Row count in that category |
disposition |
string | yes | What deletion would do with them (delete / retain_for_identity_policy / …) |
participant |
string | yes | Deletion participant service name |
OrganizationDeletionPrecheckData
| Field | Type | Required | Description |
|---|---|---|---|
agents_count |
integer (int64) | yes | Agents in the organization |
blockers |
array of string | yes | Conditions that currently block deletion, prefixed with the reporting participant |
conversations_count |
integer (int64) | yes | Conversations deletion would remove; null when the count is unavailable |
credits_balance |
integer (int64) | yes | Credit balance (points) deletion would forfeit; null when the balance is unavailable |
impact |
array of OrganizationDeletionImpactDTO |
yes | Per-participant, per-category impact counts |
org_id |
string (uuid) | yes | Organization UUID |
org_name |
string | yes | Organization display name |
subscription_plan |
string | yes | Current subscription plan code; null when the org has no subscription |
subscription_status |
string | yes | Current subscription status (trialing/active/past_due/suspended/canceled); null when the org has no subscription |
OrganizationDetail
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
industry |
string | yes | Organization industry key; null when never chosen |
industry_other |
string | yes | Free-text supplement for industry=other; null otherwise |
member_count |
integer (int64) | yes | Total active members |
name |
string | yes | Organization name |
org_id |
string (uuid) | yes | Organization UUID |
owner |
OrgOwnerInfo |
Organization owner (org-owner role), if present | |
slug |
string | yes | Organization slug |
status |
string: active |
yes | Organization status |
OrganizationSummary
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Organization creation time |
industry |
string | yes | Organization industry key; null when never chosen |
industry_other |
string | yes | Free-text supplement for industry=other; null otherwise |
member_id |
string (uuid) | yes | Caller's member UUID in this org |
name |
string | yes | Organization name |
org_id |
string (uuid) | yes | Organization UUID |
role_slug |
string | yes | Caller's role slug in this org (e.g. org-owner) |
slug |
string | yes | Organization slug |
status |
string: active |
yes | Organization status |
OutstandingItemDTO
| Field | Type | Required | Description |
|---|---|---|---|
item_id |
string | yes | |
kind |
string | yes | arrears | restart_daily |
period |
string | yes | Period key (RFC3339) |
points |
integer (int64) | yes | Owed points for this item (= points_per_cycle; a single slot owes at most one period) |
product_id |
string | yes |
OwnedAgentSummary
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL | |
display_name |
string | yes | Display name |
member_id |
string (uuid) | yes | Agent member UUID (drill-down target) |
model |
string | Active runtime model display name; omitted when the agent has not reported runtime metrics | |
online_status |
string: online, offline, unknown |
Online status (unknown if it cannot be determined) |
PageContentItem
| Field | Type | Required | Description |
|---|---|---|---|
additions |
integer (int32) | Lines added | |
author_avatar_url |
string | Author avatar URL | |
author_id |
string | yes | Author principal ID |
author_name |
string | Author display name | |
author_type |
string: user, agent, team, system |
yes | Author entity type |
body |
string | yes | Page content body |
created_at |
string (date-time) | yes | Creation time |
deletions |
integer (int32) | Lines removed | |
front_matter |
object | Parsed front matter | |
message |
string | Revision message | |
org_id |
string (uuid) | yes | Organization UUID |
page_id |
string (uuid) | yes | Page UUID |
revision_id |
integer (int64) | yes | Revision ID |
PageItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | Creation time |
creator_avatar_url |
string | Creator avatar URL | |
creator_id |
string | yes | Creator principal ID |
creator_name |
string | Creator display name | |
creator_type |
string: user, agent, team, system |
yes | Creator entity type |
current_revision_id |
integer (int64) | Current revision ID | |
format |
string: markdown, plain_text |
yes | Page format |
id |
string (uuid) | yes | Page UUID |
kb_id |
string (uuid) | yes | KB UUID |
last_edited_by |
string | Last editor principal ID | |
last_edited_by_type |
string: user, agent, team, system |
Last editor entity type | |
last_editor_avatar_url |
string | Last editor avatar URL | |
last_editor_name |
string | Last editor display name | |
org_id |
string (uuid) | yes | Organization UUID |
path |
string | yes | Page path |
status |
string: active, trashed |
yes | Page status |
title |
string | yes | Page title |
trashed_at |
string (date-time) | Trash time | |
updated_at |
string (date-time) | yes | Last update time |
PageListResponseApprovalItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ApprovalItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseAttemptItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of AttemptItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseBlueprintItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of BlueprintItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseInvitationSummaryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of InvitationSummary |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseIssueItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of IssueItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseMemberSummaryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of MemberSummary |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseOrganizationSummaryBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of OrganizationSummary |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseProjectItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ProjectItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseProjectMemberItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of ProjectMemberItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseRoleItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of RoleItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageListResponseTaskItemBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
array of TaskItem |
yes | Response payload |
pagination |
PageMetadata |
yes | Pagination metadata |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PageMetadata
| Field | Type | Required | Description |
|---|---|---|---|
page |
integer (int32) | yes | Current page number |
page_size |
integer (int32) | yes | Number of items per page |
total_count |
integer (int64) | yes | Total number of matching items |
total_pages |
integer (int32) | yes | Total number of pages |
PageReferenceItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string | yes | Referenced artifact ID |
display_name |
string | yes | Reference display name |
length |
integer (int32) | yes | Reference length |
offset |
integer (int32) | yes | Reference offset |
status |
string | yes | Reference status |
PatchConversationConnectorRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | yes | Whether the connector is enabled for this conversation |
PauseAgentRuntimeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentRuntimeCommandResult |
yes | Accepted runtime command result |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
PaymentMethodDTO
| Field | Type | Required | Description |
|---|---|---|---|
bound_at |
string (date-time) | UTC creation instant of the verified payment credential; absent when no verified creation time is known | |
credential_id |
string | ||
display_brand |
string | ||
display_exp |
string | ||
display_last4 |
string | ||
id |
string | yes | |
is_default |
boolean | yes | |
method_type |
string | yes | card|wechat|alipay |
status |
string | yes | pending_setup|active|expiring|expired|revoked|failed |
PaymentMethodListDTO
| Field | Type | Required | Description |
|---|---|---|---|
methods |
array of PaymentMethodDTO |
yes |
PlanStateDTO
| Field | Type | Required | Description |
|---|---|---|---|
addons |
array of AddonSummaryDTO |
yes | |
current_payment_method |
PaymentMethodDTO |
Display details of the subscription's payment credential, safe to show; absent when no verified credential is known | |
entitlements |
EntitlementsDTO |
||
has_ever_paid_plan |
boolean | yes | The org has ever paid for a plan subscription (credit packs do not count). A client shows the free-trial request entry exactly when !has_ever_paid_plan && subscription.status != trialing |
is_paid_plan |
boolean | yes | The org's current subscription is a paid plan (billing-computed) |
subscription |
SubscriptionStateDTO |
||
trial_eligible |
boolean | yes | Org-level trial eligibility: a card subscription would get the 7-day trial. Clients apply the card-only condition themselves; submit-time validation remains authoritative |
usage_snapshot |
UsageSnapshotDTO |
PlatformAgentDomainAvailabilityData
| Field | Type | Required | Description |
|---|---|---|---|
available |
boolean | yes | Whether the domain is available |
domain |
string | yes | Full domain assembled from the label and configured suffix |
label |
string | yes | Normalized subdomain label |
PlatformAgentDomainConfigData
| Field | Type | Required | Description |
|---|---|---|---|
availability_check_label |
string | yes | Human-readable availability check capability |
availability_check_mode |
string: database |
yes | Current availability check capability |
domain_binding_enabled |
boolean | yes | Whether this deployment binds public domains to platform agents. true ⇒ global (binding available); false ⇒ China region (agent domain suffix not configured, binding disabled; clients should hide domain inputs/sections) |
suffix |
string | yes | Configured agent domain root suffix without a leading dot. Empty when domain binding is disabled (CN deployment) |
PlatformAgentDomainData
| Field | Type | Required | Description |
|---|---|---|---|
full_domain |
string | yes | Full public domain bound to the agent |
label |
string | yes | Subdomain label |
root_suffix |
string | yes | Configured agent domain root suffix |
PlatformAgentOperationalStateDTO
| Field | Type | Required | Description |
|---|---|---|---|
actual_observed_at |
string (date-time) | When the agent runtime observed actual_phase | |
actual_phase |
string: starting, online, stopping, offline, paused, error, unknown |
yes | Actual runtime phase observed from the agent runtime |
addon_id |
string | yes | Add-on ID; a stable key for the item |
addon_status |
string | yes | Current add-on status |
available_actions |
array of string | yes | Actions currently allowed for this caller, derived from the authoritative add-on status (active offers pause; paused/suspended offers resume). Withheld only while a conflicting operation is in flight (operation/phase set) or the required billing state is unavailable. Independent of the runtime actual_phase, which can degrade to unknown without withholding pause/resume. |
credit_cap |
AgentCreditCapDTO |
||
desired_phase |
string: online, paused, deleted, unknown |
yes | Desired runtime phase, owned by the billing system |
failure |
string | Machine-readable failure or required-action reason | |
identity_id |
string (uuid) | Agent identity UUID; absent while creation has not produced an identity | |
member_id |
string (uuid) | Agent member UUID; absent while creation has not produced a member | |
openmax_connection |
string: online, offline, unknown |
yes | Presence of the agent's messaging connection; independent from actual runtime phase |
operation |
string: creating, pausing, resuming, deleting |
Current operation; absent when idle | |
phase |
string: in_progress, waiting_online, failed, action_required |
Current operation phase; absent when idle | |
requested_at |
string (date-time) | When the current operation was requested | |
runtime_observation_availability |
string: available, unavailable, not_applicable |
Whether the agent runtime returned an observation; independent from the billing desired state | |
sku_code |
string | yes | SKU code of the add-on |
tier |
string | yes | Agent add-on tier |
PollAgentDingtalkScanData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
The pending DingTalk binding created by the shared connect path on a successful scan. Only set when status is "connected". | |
status |
string | yes | Scan session status: pending | connected | expired | cancelled | error |
PollAgentDingtalkScanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
session_handle |
string | yes | The device code returned by the start-scan step |
PollAgentFeishuScanData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
The pending Feishu binding created by the shared connect path on a successful scan. Only set when status is "connected". | |
status |
string | yes | Scan session status: pending | connected | expired | cancelled | error |
PollAgentFeishuScanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
session_handle |
string | yes | The device code returned by the start-scan step |
PollAgentLarkScanData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
The pending Lark binding created by the shared connect path on a successful scan. Only set when status is "connected". | |
status |
string | yes | Scan session status: pending | connected | expired | cancelled | error |
PollAgentLarkScanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
session_handle |
string | yes | The device code returned by the start-scan step |
PollAgentWecomScanData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
The pending WeCom binding created by the shared connect path on a successful scan. Only set when status is "connected". | |
status |
string | yes | Scan session status: pending | connected | expired | cancelled | error |
PollAgentWecomScanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
session_handle |
string | yes | The scan code (scode) returned by the start-scan step |
PrepareAvatarUploadInputBody
| Field | Type | Required | Description |
|---|---|---|---|
content_type |
string | yes | Image MIME type: image/png, image/jpeg or image/webp |
filename |
string | yes | Original image filename (plain name, 1..255 characters) |
size_bytes |
integer (int64) | yes | Image size in bytes, 1..5242880 (5 MiB) |
PrepareCommUploadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
content_type |
string | yes | Content type |
filename |
string | yes | File name |
size_bytes |
integer (int64) | yes | File size in bytes |
PrepareUploadItem
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string (date-time) | Upload URL expiration time | |
headers |
object | yes | Headers required for upload |
instant_upload |
boolean | yes | Whether the upload can be finalized without uploading bytes |
upload_token |
string | yes | Opaque upload token |
upload_url |
string | yes | Presigned upload URL |
PrepareUploadRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
content_type |
string | yes | Content type |
filename |
string | yes | File name |
parent_id |
string (uuid) | Parent folder node UUID | |
size_bytes |
integer (int64) | yes | File size in bytes |
PrepareUploadResult
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string | yes | When the upload expires |
headers |
object | yes | Upload headers |
instant_upload |
boolean | yes | Whether no upload body is required |
upload_token |
string | yes | Upload token |
upload_url |
string | yes | Upload URL |
PreviewEventBindingRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
anchor_at |
string (date-time) | Interval phase anchor instant | |
cron_expr |
string | Five-field cron expression, required for cron schedules | |
interval_seconds |
integer (int64) | Elapsed interval in seconds | |
run_at |
string (date-time) | Once trigger instant | |
schedule_kind |
string: cron, once, interval |
Schedule mode; omitted means cron | |
timezone |
string | IANA timezone; omitted or empty applies no timezone |
PrivateWorkspaceResult
| Field | Type | Required | Description |
|---|---|---|---|
created_knowledge_base |
boolean | yes | True only for the call that created (or restored) the knowledge base |
created_project |
boolean | yes | True only for the call that created the project |
knowledge_base |
KbItem |
yes | The caller's personal private knowledge base, bound to the project |
project |
ProjectItem |
yes | The caller's personal private project |
PrivateWorkspaceStatus
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | yes | Whether private projects and the personal workspace can be created now (automation_private_scope_enabled) |
has_private_project |
boolean | yes | Whether the caller owns or ever owned a private project; archived ones count |
ProjectItem
| Field | Type | Required | Description |
|---|---|---|---|
archived_at |
string (date-time) | Archive time | |
created_at |
string (date-time) | yes | Creation time |
description |
string | yes | Project description |
id |
string (uuid) | yes | Project UUID |
is_default |
boolean | yes | Whether this is the default project for the organization |
knowledge_base_id |
string (uuid) | Knowledge base UUID | |
lead_member_id |
string (uuid) | yes | Lead member UUID |
name |
string | yes | Project name |
org_id |
string (uuid) | yes | Organization UUID |
owner_member_id |
string (uuid) | Owner of a private project (also its fixed lead); absent for organization projects | |
scope |
string: org, private |
yes | org: visible per the organization's rules; private: only its owner and the owner's Agents that are members can see it |
slug |
string | yes | Project slug |
starred |
boolean | yes | Whether the authenticated caller has starred this project. Caller-relative and private to the caller; always false on create. |
status |
string: active, archived |
yes | Project status |
system_kind |
string: my_private |
my_private for the owner's personal private project created by POST /api/v1/me/private-workspace; absent otherwise | |
updated_at |
string (date-time) | yes | Last update time |
ProjectMemberItem
| Field | Type | Required | Description |
|---|---|---|---|
added_at |
string (date-time) | yes | Project member add time |
id |
string (uuid) | yes | Project member UUID |
member_id |
string (uuid) | yes | Member UUID |
project_id |
string (uuid) | yes | Project UUID |
role |
string: member, lead |
yes | Project member role |
ProxyConnectForwardRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
body |
any | Request body | |
headers |
object | Headers to forward | |
method |
string | yes | HTTP method |
url |
string | yes | Target URL/path |
QueryConnectAgentUsableConnectionsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_member_ids |
array of string (uuid) | yes | Agent member UUIDs, 1..50 as sent. Duplicates are collapsed (first occurrence keeps its position). An empty list, more than 50 ids or a malformed UUID rejects the whole request with 400. |
statuses |
array of string: active, needs_reauth, error, expired, pending, revoked |
Connection status filter; a connection is returned when it matches any value. Omitted or empty = ["active"]. needs_reauth = status error WITH a pending re-authorization; error = status error WITHOUT one; the rest match the stored status. An unknown value rejects the whole request with 400. |
QueryConnectApplicationsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
application_ids |
array of string (uuid) | yes | Application UUIDs, 1..100 as sent. Duplicates (case-insensitive) are collapsed, the first occurrence keeping its position. An empty list, more than 100 ids or a malformed UUID rejects the whole request with 400. |
Quota
| Field | Type | Required | Description |
|---|---|---|---|
auto_limit_bytes |
integer (int64) | yes | |
auto_limit_reached |
boolean | yes | |
capacity_bytes |
integer (int64) | yes | |
increment_bytes |
integer (int64) | yes | |
organization_id |
string | yes | |
updated_at |
string (date-time) | yes | |
used_bytes |
integer (int64) | yes |
ReactionAggregate
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Reaction code from the server-side reaction registry |
count |
integer (int32) | yes | Total number of reactors for this code |
reacted_by_me |
boolean | yes | Whether the authenticated caller has this reaction on the message |
reactor_ids |
array of string | Reactor member UUIDs (at most the first 20; count may exceed the list length) | |
unicode_fallback |
string | yes | Unicode emoji rendered by clients that do not know the code |
ReactionChangeResult
| Field | Type | Required | Description |
|---|---|---|---|
change_seq |
integer (int64) | yes | Conversation change_seq this call allocated, so the acting device can advance its change watermark. 0 when nothing changed (idempotent no-op). |
ReadCursorItem
| Field | Type | Required | Description |
|---|---|---|---|
last_ack_seq |
integer (int64) | yes | Effective delivery watermark, folded to max(ack, read): messages with seq <= this value are delivered |
last_read_seq |
integer (int64) | yes | Messages with seq <= this value are read by the member |
member_id |
string (uuid) | yes | Conversation member (user or agent) UUID |
ReadCursorsResult
| Field | Type | Required | Description |
|---|---|---|---|
cursors |
array of ReadCursorItem |
yes | Per-member cursor pairs, capped at 500 ordered by last_read_seq descending |
member_count |
integer (int32) | yes | True member count regardless of truncation |
truncated |
boolean | yes | True when the cursor list was capped below member_count |
ReassignIssueOwnerRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
new_owner_member_id |
string (uuid) | yes | New owner member UUID |
ReassignTaskRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
new_assignee_id |
string (uuid) | yes | New assignee member UUID |
RecallMessageResult
| Field | Type | Required | Description |
|---|---|---|---|
change_seq |
integer (int64) | yes | Conversation change_seq this recall allocated. 0 when nothing changed (a concurrent recall or delete won). |
RenameEventBindingRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
expected_version |
integer (int64) | yes | |
title |
string | yes | Automation title; at most 200 Unicode code points |
RenameNodeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Tree node name |
RequestInteractionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_run |
object | Optional opaque agent run summary attached to the card (agent execution visibility, schema_version 2). Kept unchanged, only for agent senders, only when its encoded size is at most 16 KiB and only while agent activity is enabled; otherwise it is dropped silently and the card is still sent. | |
choice |
ChoiceInteractionInput |
Required when interaction_type is choice | |
client_msg_id |
string | Caller-generated dedup key for the send itself. At most 64 characters; a longer value is rejected. | |
form |
FormInteractionInput |
Required when interaction_type is form | |
interaction_type |
string: choice, form |
yes | Which kind of interaction this requests. The protocol reserves select_resource and domain_gate; an unknown value is refused here because this endpoint has to pick a variant for it. |
ResolveConnectShopifyAppInstallRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
ticket |
string | yes | One-time claim ticket from the claim page URL (/connect/shopify/claim?ticket=...); not consumed |
ResolveURIsData
| Field | Type | Required | Description |
|---|---|---|---|
failed |
array of string | yes | URIs that could not be resolved |
resolved |
object | yes | Successfully resolved URIs |
ResolveURIsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
inline |
boolean | If true, return inline content-disposition URLs | |
uris |
array of string | yes | List of artifact:// URIs to resolve |
ResolvedURI
| Field | Type | Required | Description |
|---|---|---|---|
content_length |
integer (int64) | yes | File size in bytes |
content_type |
string | yes | MIME type |
download_url |
string | yes | Download URL: a presigned storage URL, or, when download tickets are enabled, a short-lived platform URL (GET /api/public/artifacts/download/{ticket}) that redirects to one |
expires_at |
string (date-time) | yes | URL expiration time (the ticket expiry when download_url is a ticket URL) |
name |
string | yes | Original file name |
RestartAgentRuntimeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
upgrade_image |
boolean | When true, upgrade the agent to its latest resolved runtime image before restarting (heavier: teardown/recreate, running tasks may be lost). Default false = plain in-place restart. |
RestartAgentRuntimeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentRuntimeCommandResult |
yes | Accepted runtime command result |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ResumeAgentRuntimeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
AgentRuntimeCommandResult |
yes | Accepted runtime command result |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
ResumeIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
expected_plan_token |
string | Optional current_plan_token of the plan the owner's feedback refers to (an empty string when the issue has no current_plan_token). Send it only to give feedback on an issue in pending_plan, only as the issue owner and with a non-empty reason; do not send it when resuming a delivered issue. With a token, a non-owner gets 403, a silent automation's or archived issue is refused, an issue not in pending_plan gets 412, and a plan that has changed since gets 412 WORK_ISSUE_PLAN_CHANGED. Omit for an ordinary resume; null is invalid | |
reason |
string | Human feedback or reason for resuming work | |
source |
string | Origin of the resume action (e.g. lead_chat) |
RetryWebhookDeliveryRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
expected_version |
integer (int64) | yes |
RevisionDiffItem
| Field | Type | Required | Description |
|---|---|---|---|
diff |
string | yes | Revision diff |
from_revision |
integer (int64) | yes | Base revision ID |
org_id |
string (uuid) | yes | Organization UUID |
page_id |
string (uuid) | yes | Page UUID |
to_revision |
integer (int64) | yes | Target revision ID |
RevisionSummaryItem
| Field | Type | Required | Description |
|---|---|---|---|
additions |
integer (int32) | Lines added | |
author_id |
string | yes | Author principal ID |
author_type |
string: user, agent, team, system |
yes | Author entity type |
created_at |
string | yes | Creation time |
deletions |
integer (int32) | Lines removed | |
message |
string | Revision message | |
org_id |
string (uuid) | yes | Organization UUID |
page_id |
string (uuid) | yes | Page UUID |
revision_id |
integer (int64) | yes | Revision ID |
RevokeApprovalRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Revoke reason |
RoleItem
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | yes | Role description |
display_name |
string | yes | Human-readable role name |
is_builtin |
boolean | yes | Whether this is a system-defined role |
role_id |
string (uuid) | yes | Role UUID |
scope |
string: org, workspace |
yes | Role scope |
slug |
string | yes | Role slug (e.g. org-owner, workspace-member) |
RunEventBindingRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
confirm_paused |
boolean | Explicit acknowledgement to run once while paused; does not resume scheduling | |
expected_version |
integer (int64) | yes | Current configuration version |
idempotency_key |
string | yes | Stable key for retries of one manual run, scoped to this binding |
RuntimeMetricsCost
| Field | Type | Required | Description |
|---|---|---|---|
daily |
number (double) | Today's cumulative cost (USD) | |
session |
number (double) | Current session cost (USD) | |
weekly |
number (double) | This week's cumulative cost (USD) |
RuntimeMetricsResources
| Field | Type | Required | Description |
|---|---|---|---|
cpu_pct |
number (double) | CPU usage percentage | |
disk_alert_tier |
integer (int32) | Highest disk usage alert tier crossed (80 or 90); read-only | |
disk_free_bytes |
integer (int64) | Free disk space in bytes | |
disk_full |
boolean | Whether write-full protection is active; read-only | |
disk_full_since |
string (date-time) | When write-full protection started; read-only | |
disk_pct |
number (double) | Disk usage percentage | |
disk_total_bytes |
integer (int64) | Total disk size in bytes; derived from disk_free_bytes and disk_pct when omitted | |
mem_pct |
number (double) | Memory usage percentage | |
mem_total_bytes |
integer (int64) | Total memory in bytes | |
mem_used_bytes |
integer (int64) | Used memory in bytes |
RuntimeMetricsRuntime
| Field | Type | Required | Description |
|---|---|---|---|
context_pct |
number (double) | Context window usage percentage | |
effort |
string | Reasoning effort level | |
model |
string | Active model display name | |
model_id |
string | Active model identifier | |
state |
string | Agent runtime state |
SearchHitItem
| Field | Type | Required | Description |
|---|---|---|---|
accessible |
boolean | yes | Whether the current caller can access this hit |
author_id |
string | yes | Author principal ID |
author_type |
string | yes | Author entity type |
created_at |
string | yes | Creation time |
kb_id |
string (uuid) | yes | KB UUID |
org_id |
string (uuid) | yes | Organization UUID |
page_id |
string (uuid) | yes | Page UUID |
path |
string | yes | Page path |
snippet |
string | yes | Search snippet |
title |
string | yes | Page title |
updated_at |
string | yes | Last update time |
SearchMessagesRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
cursor |
string | Pagination cursor | |
limit |
integer (int32) | Items per page (default: 20, max: 100) | |
query |
string | yes | Search query |
SendMessageRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
agent_run |
object | Optional opaque agent run summary (agent execution visibility, schema_version 2). Kept unchanged, only for agent senders, only when its encoded size is at most 16 KiB and only while agent activity is enabled; otherwise it is dropped silently and the message is still sent. Replaces the retired metadata.agent_run key, which is now stripped from metadata. | |
client_msg_id |
string | yes | Client idempotency key. At most 64 characters; a longer value is rejected. |
content |
MessageContentItem |
yes | Message content |
fallback_text |
string | Preview/fallback text — the short plaintext the conversation list shows for non-text messages. Required for card messages; omit and the platform derives it from the card body: the card title in black lenticular brackets (U+3010 / U+3011) followed by the summary. Capped at 8192 UTF-8 bytes by the platform. | |
mentions |
array of MentionInput |
Structured @mention targets. The platform does not parse @names from the message text; this array is the only mention source. | |
metadata |
object | Optional metadata | |
parent_id |
string | Parent message ID for reply | |
priority |
integer (int32) | 1=urgent, 2=high, 3=normal; omit defaults to normal. In a DM to your own agent, normal is floored to high. | |
thread_id |
string (uuid) | Thread UUID | |
ttl |
integer (int32) | Time to live in seconds | |
type |
string: UNSPECIFIED, TEXT, IMAGE, FILE, AUDIO, VIDEO, SYSTEM, AGENT_TEXT, AGENT_STRUCTURED, AGENT_CARD, AGENT_STREAM |
yes | Message type |
SendMessageResult
| Field | Type | Required | Description |
|---|---|---|---|
conversation_id |
string (uuid) | yes | Conversation UUID |
id |
string | yes | Identifier of the stored message. Exception: when moderation.blocked is true nothing was stored and this is the synthetic placeholder "blocked- |
moderation |
SendModeration |
Set only when the keyword filter blocked this (human) send; absent means it did nothing. When blocked, the message was withheld — never stored, never delivered to anyone — and nothing was posted in its place: id is the synthetic "blocked- |
|
seq |
integer (int64) | yes | Conversation sequence |
timestamp |
string (date-time) | yes | Message timestamp |
SendModeration
| Field | Type | Required | Description |
|---|---|---|---|
blocked |
boolean | yes | The human message was withheld (never stored, never delivered to anyone) and nothing was posted in its place |
refusal_text |
string | Set when blocked: the refusal copy to show the sender as a system notice (it has no sender) |
SetAgentAvatarInputBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | yes | Avatar URL returned by POST /api/v1/avatars/uploads/finalize in this organization, or "" to restore the default avatar |
SetAgentCapabilityTagsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
tags |
array of CapabilityTagInputDTO |
yes | Full replacement capability-tag set for the agent (declarative; the prior set is replaced) |
SetAppBadgeItem
| Field | Type | Required | Description |
|---|---|---|---|
count |
integer (int64) | The number to show, 1 to 1000000 (shown as 99+ above 99); 0 clears the badge. Give exactly one of count and dot | |
dot |
boolean | true shows a dot without a number; false clears the badge. Give exactly one of count and dot | |
member_id |
string | yes | The member the badge is for: a member id, as in user.member_id of the app token response |
SetAppBadgesData
| Field | Type | Required | Description |
|---|---|---|---|
applied |
integer (int64) | yes | Badges set for valid members (including writes that changed nothing, or that a stored badge with a later as_of outranked) |
cleared |
integer (int64) | yes | Badges cleared for valid members (count 0 or dot false) |
skipped |
integer (int64) | yes | Items whose member_id is not an active human member of the organization (Agents included); not told apart |
SetAppBadgesRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
app_id |
string | The App ID (app_...), when not sent with HTTP Basic | |
app_secret |
string | The App Secret, when not sent with HTTP Basic | |
as_of |
string (date-time) | When the app computed these values (RFC 3339); a stored badge with a later as_of is kept (out of order protection). Defaults to the server clock; at most 5 minutes ahead of it | |
items |
array of SetAppBadgeItem |
yes | 1 to 500 badges, one per member (a member_id at most once); more than 500 is a 422, an empty list a 400. Each sets the member's whole value for this app (set, not increment) |
org_id |
string | yes | The organization (UUID) whose installation of the app the badges are for; an official app installed in several organizations names one per request |
SetGroupAllowFromRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
allow_from |
array of string | yes | Member UUIDs allowed to trigger the agent in this group |
SetGroupAllowFromResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
change_id |
string | yes | Pending policy change ID; poll GET /api/v1/agents/{agent_member_id}/policy-changes/{change_id} for its outcome |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: applying, applied, failed |
yes | Change status at write time; always applying on success (the agent has not confirmed it yet) |
SetGroupModeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
mode |
string: smart, mention |
yes | Group response mode |
SetGroupModeResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
change_id |
string | yes | Pending policy change ID; poll GET /api/v1/agents/{agent_member_id}/policy-changes/{change_id} for its outcome |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: applying, applied, failed |
yes | Change status at write time; always applying on success (the agent has not confirmed it yet) |
SetStepsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
steps |
array of StepInput |
yes | Replacement blueprint steps |
SettleCardChoiceRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
selected_action_ids |
array of string | yes | Card-local ids of the chosen options. For selection_mode=single this is exactly one id. |
selection_mode |
string | yes | How many options the card accepts. The protocol reserves 'multiple'; the platform serves only 'single' today and fails closed on anything else. |
SkillDTO
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Skill description (for human and LLM semantic matching) | |
name |
string | yes | Human-readable skill name |
skill_id |
string | yes | Skill identifier (Skill.id from the agent domain) |
SpecStruct
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Issue description; at most 1500 Unicode code points | |
knowledge_base_id |
string (uuid) | Required exactly for knowledge_base_mode custom; must fit the project's scope (an organization project's automation cannot use a private knowledge base, a private one needs its owner's) | |
knowledge_base_mode |
string: project_default, custom, none |
Where runs store their outputs: project_default uses the project's knowledge base (for an unattached private automation, the Owner's personal private project's at run time), custom uses knowledge_base_id, none stores nothing in a knowledge base. Omitted on a create means project_default; an update that omits it (and knowledge_base_id) keeps the current choice, so send project_default to reset | |
project_id |
string (uuid) | Project UUID; required unless unattached | |
title |
string | yes | Issue title; at most 200 Unicode code points |
unattached |
boolean | The automation belongs to no project. With project_id omitted, unattached_scope chooses where it runs: the organization Inbox, or the Owner's hidden private project (created on first use; needs the Owner's private workspace). An update may name the project an earlier read returned. Omitted on a create means attached; an update that omits it keeps the current attachment, so send false to attach an unattached automation to project_id | |
unattached_scope |
string: org, private |
With unattached and no project_id: org (default) or private. A private one is created only by its Owner, whose own Agent leads it and joins through project_member_additions |
StarItem
| Field | Type | Required | Description |
|---|---|---|---|
created_at |
string (date-time) | yes | When the caller starred the object (kept on re-star) |
object_id |
string | yes | Id of the starred object in its owning service |
object_type |
string | yes | Object type: knowledge_base, automation, agent or connector |
StarList
| Field | Type | Required | Description |
|---|---|---|---|
items |
array of StarItem |
yes | The caller's stars of the requested type, newest first. Not paginated: a soft cap of about 500 per type bounds it. |
StartAgentDingtalkScanData
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string | yes | DingTalk authorization URL encoded in the QR (for rendering a custom QR or offering a fallback link) |
expires_in_sec |
integer (int32) | yes | How long the scan session is valid, in seconds (DingTalk device codes expire ~2 hours after generation) |
qr_png_base64 |
string | yes | Base64-encoded PNG of the QR code the user scans with the DingTalk app to authorize |
session_handle |
string | yes | DingTalk device code; the stateless, non-secret handle to pass back to the poll step |
user_code |
string | yes | Short user code the user can enter manually as a fallback to scanning the QR |
StartAgentFeishuScanData
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string | yes | Feishu authorization URL encoded in the QR (for rendering a custom QR or offering a fallback link) |
expires_in_sec |
integer (int32) | yes | How long the scan session is valid, in seconds (Feishu device codes expire ~5 minutes after generation) |
qr_png_base64 |
string | yes | Base64-encoded PNG of the QR code the user scans with the Feishu app to authorize |
session_handle |
string | yes | Feishu device code; the stateless, non-secret handle to pass back to the poll step |
user_code |
string | yes | Short user code the user can enter manually as a fallback to scanning the QR |
StartAgentLarkScanData
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string | yes | Lark authorization URL encoded in the QR (for rendering a custom QR or offering a fallback link) |
expires_in_sec |
integer (int32) | yes | How long the scan session is valid, in seconds (Lark device codes expire ~5 minutes after generation) |
qr_png_base64 |
string | yes | Base64-encoded PNG of the QR code the user scans with the Lark app to authorize |
session_handle |
string | yes | Lark device code; the stateless, non-secret handle to pass back to the poll step |
user_code |
string | yes | Short user code the user can enter manually as a fallback to scanning the QR |
StartAgentWecomScanData
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string | yes | WeCom authorization URL encoded in the QR (for rendering a custom QR or offering a fallback link) |
expires_in_sec |
integer (int32) | yes | How long the scan session is valid, in seconds (WeCom scodes expire ~5 minutes after generation) |
qr_png_base64 |
string | yes | Base64-encoded PNG of the QR code the user scans with the WeCom app to authorize |
session_handle |
string | yes | WeCom scan code (scode); the stateless, non-secret handle to pass back to the poll step |
StartAgentWhatsappBusinessRegistrationData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
yes | The pending WhatsApp Business binding created/updated by step 1 |
masked_number |
string | yes | Display-only, partially-masked rendering of the number (e.g. "+1 ******4567") for confirmation UIs |
phone_number_id |
string | yes | Meta Graph id of the added number; the stateless session handle to pass back to the submit-code step (not secret) |
StartAgentWhatsappBusinessRegistrationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
cc |
string | yes | Country calling code (1-4 digits), e.g. "1" |
code_method |
string | OTP delivery method: sms | voice (case-insensitive; empty defaults to sms) | |
display_name |
string | Business display name shown on WhatsApp (Meta verified_name, 1-75 chars) | |
phone_number |
string | yes | National number without the country code (4-15 digits) |
StartTaskData
| Field | Type | Required | Description |
|---|---|---|---|
attempt |
AttemptItem |
yes | Created attempt |
task |
TaskItem |
yes | Started task |
StepInput
| Field | Type | Required | Description |
|---|---|---|---|
depends_on_temp_ids |
array of string | Temporary dependency step IDs | |
description |
string | yes | Step description |
required_resources |
object | Required resources JSON object | |
temp_id |
string | yes | Temporary step ID |
SubConversationOwnerInput
| Field | Type | Required | Description |
|---|---|---|---|
app_id |
string | See kind. Never used to pick the owner. | |
kind |
string: app, platform |
Ignored for app access tokens (the owner is always the token's app). Other callers act as the platform: omit it or send platform; naming an app is refused with 403 SUBCONVERSATION_OWNER_NOT_ALLOWED. |
SubConversationResult
| Field | Type | Required | Description |
|---|---|---|---|
conversation |
ConversationItem |
yes | The sub-conversation (never its parent) |
created |
boolean | yes | Whether a new sub-conversation was created |
SubmitAgentWhatsappBusinessCodeData
| Field | Type | Required | Description |
|---|---|---|---|
binding |
AgentChannelBindingItem |
yes | The WhatsApp Business binding, now connected |
inbound_enabled |
boolean | yes | Whether the per-number webhook override was applied. False when the resolved webhook base URL was empty or the override call failed (non-blocking); the binding is still connected but inbound routes to the app-level webhook. |
SubmitAgentWhatsappBusinessCodeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Verification code the user received (4-8 digits). Never stored or logged. |
phone_number_id |
string | yes | The stateless session handle returned by the start-registration step |
webhook_base_url |
string | Optional explicit webhook base URL override. When empty the platform resolves it from the agent's bound platform domain; when neither is present the number is connected with inbound disabled. |
SubmitCardInteractionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
action |
CardActionSubmitInput |
Required when interaction_type is action | |
choice |
CardChoiceSubmitInput |
Required when interaction_type is choice | |
form |
CardFormSubmitInput |
Required when interaction_type is form | |
interaction_type |
string: choice, form, action |
yes | Which kind of card interaction this is; selects the one payload object that must accompany it. |
SubmitIssuePlanRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
blueprint_id |
string (uuid) | yes | Blueprint UUID for the submitted execution plan |
card_message_id |
string (uuid) | Optional IM card message UUID | |
plan_text |
string | yes | Markdown plan text shown to the human for confirmation |
source |
string | Origin of the plan request (e.g. lead_chat, text_card_proxy) |
SubscriptionIntentReadDTO
| Field | Type | Required | Description |
|---|---|---|---|
amount_due_cents |
integer (int64) | yes | |
billing_interval |
string | month|quarter|year | |
checkout |
CheckoutHandleDTO |
||
currency |
string | yes | |
expires_at |
string (date-time) | Intent expiry (created_at + TTL); non-null only for the TTL-bearing form (a subscription created bare order without a trial handle), null for exempt/dispatched forms | |
intent_id |
string | yes | = biz_order_id (the intent head's current order) |
next_step |
string | yes | checkout|trial_setup|zero_amount_done|zero_amount_done_setup_pending|already_settled (idempotent replay hit an already-settled order — terminal success, no checkout handle)|processing (GET-only: an in-flight order the client polls, never an error) |
payment_method |
string | card|wechat|alipay; may be empty when the method is chosen at checkout — not a reliable match key | |
plan_code |
string | The plan this intent is for (target_ref) | |
subscription_status |
string | ||
trial_eligible |
boolean | yes | |
trial_end |
string (date-time) |
SubscriptionStateDTO
| Field | Type | Required | Description |
|---|---|---|---|
activation_order_id |
string | Current contract activation identity; use with plan_version for Admin custom termination preconditions | |
allow_self_purchase |
boolean | yes | Whether this custom-plan policy permits user-initiated credit-pack purchases |
auto_renew |
boolean | yes | |
auto_renew_off_reason |
string | user_cancel|setup_pending|setup_failed|no_credential. Empty when auto_renew is on, for one_time payment methods, on Free, or when no reason is known. setup_pending is the only user-resolvable cause. | |
billing_interval |
string | yes | month|quarter|year |
can_cancel |
boolean | yes | Server-owned capability for canceling the current subscription |
can_change_plan |
boolean | yes | Server-owned capability for changing the current plan |
can_manage_auto_topup |
boolean | yes | Server-owned capability for managing automatic credit top-up |
can_manage_credit_payment_methods |
boolean | yes | Server-owned capability for saved payment methods used in self-purchased credits; does not authorize subscription renewal or auto-top-up |
can_manage_payment |
boolean | yes | Server-owned capability for managing subscription payment methods |
carried_coupon_code |
string | ||
carried_coupon_duration |
string | one_time|first_n_cycles|forever | |
carried_coupon_duration_cycles |
integer (int32) | Cycle count when carried_coupon_duration is first_n_cycles | |
credential_id |
string | Exact credential pinned for future renewal; never infer it from the default or newest payment method | |
currency |
string | yes | |
current_cycle_grant_points |
integer (int64) | Authoritative quota for the current custom-plan grant cycle; not wallet balance or proof of settlement | |
current_period_end |
string (date-time) | ||
current_period_start |
string (date-time) | ||
custom_plan |
boolean | yes | |
free_fallback_reason |
string | renewal_failed|trial_expired. Empty for a deliberate Free choice, a planned period-end downgrade, or when no reason is known. | |
managed_started_at |
string (date-time) | Original admin-managed activation time; absent when the billing system cannot establish it, never inferred from the rolling billing period | |
managed_until |
string (date-time) | Administrative service cutoff for an admin_managed subscription | |
next_charge_amount_cents |
integer (int64) | Minor units (cents). What the next charge will be, from the same target resolution and coupon carry the charge itself uses — including a mid-trial pending plan change. Present only on GET /billing/plan-state; absent elsewhere. A present 0 is a real amount (100%-off carried coupon), so do not treat 0 as missing. Caveat: an active subscription's recurring coupon is not yet reflected, and a canceled / auto_renew=false subscription still reports a figure although nothing will be collected. | |
next_cycle_grant_points |
integer (int64) | Quota scheduled for the next custom-plan grant cycle; changing it does not issue or reclaim current Credits | |
next_grant_at |
string (date-time) | Authoritative next monthly grant boundary; distinct from a quarterly or annual payment-period end | |
payment_method |
string | Exact method family pinned for future renewal: card|alipay|wechat; may be empty when no method is pinned | |
pending_billing_interval |
string | ||
pending_change_at |
string (date-time) | ||
pending_change_revision |
string | yes | Opaque decimal int64 revision; preserve with the raw pending fields when cancelling a scheduled change |
pending_plan_code |
string | ||
plan_code |
string | yes | |
plan_name |
string | yes | |
plan_version |
integer (int32) | yes | |
price_id |
string | yes | |
renewal_mode |
string | yes | psp|admin_managed; server-owned renewal lifecycle |
status |
string | yes | trialing|active|past_due|suspended|canceled |
trial_end |
string (date-time) | ||
unit_amount_cents |
integer (int64) | yes | Minor units (cents) |
SyncCommRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
device_id |
string | yes | Device ID |
limit |
integer (int32) | Maximum events to return | |
since_seq |
integer (int64) | yes | Last seen sync sequence |
SyncEventItem
| Field | Type | Required | Description |
|---|---|---|---|
conversation_id |
string (uuid) | yes | Conversation UUID |
message_id |
integer (int64) | yes | Message ID |
seq |
integer (int64) | yes | Sync sequence |
timestamp |
string (date-time) | yes | Event timestamp |
SyncResult
| Field | Type | Required | Description |
|---|---|---|---|
events |
array of SyncEventItem |
yes | Sync events |
has_more |
boolean | yes | Whether more events are available |
next_cursor |
string | yes | Decimal string cursor for the next sync: a monotonically increasing positive integer. Send it back unchanged as since_seq and only compare it for ordering; never derive it from event seq values. It can be greater than the seq of the last event on this page. |
TaskItem
| Field | Type | Required | Description |
|---|---|---|---|
archived_at |
string (date-time) | Archive time inherited from the project | |
assignee_id |
string (uuid) | Assignee member UUID | |
assignee_status |
string: active, suspended, departed |
Current membership status of the assignee | |
blueprint_step_id |
string (uuid) | Blueprint step UUID | |
created_at |
string (date-time) | yes | Creation time |
current_attempt_number |
integer (int32) | yes | Current attempt number |
depends_on |
array of string (uuid) | Task dependency UUIDs | |
description |
string | yes | Task description |
finished_at |
string (date-time) | Finish time | |
id |
string (uuid) | yes | Task UUID |
issue_id |
string (uuid) | yes | Issue UUID |
org_id |
string (uuid) | yes | Organization UUID |
project_id |
string (uuid) | yes | Project UUID |
started_at |
string (date-time) | Start time | |
status |
string: pending, assigned, running, done, failed, cancelled |
yes | Task status |
title |
string | yes | Task title |
updated_at |
string (date-time) | yes | Last update time |
TerminateIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Why the issue is being terminated | |
source |
string | Origin of the terminate action (e.g. lead_chat, ui) |
TimezonesData
| Field | Type | Required | Description |
|---|---|---|---|
timezones |
array of string | yes | Sorted list of selectable IANA timezone names (e.g. Asia/Shanghai) plus UTC: the zones of inhabited regions, without historical aliases or placeholder names (e.g. Japan, US/Pacific, Zulu) |
TokenUsageItem
| Field | Type | Required | Description |
|---|---|---|---|
cache_read |
integer (int32) | Cache-read tokens | |
input |
integer (int32) | yes | Input tokens |
output |
integer (int32) | yes | Output tokens |
TransitionAttemptRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
blocked_on_approval_request_ids |
array of string (uuid) | Blocked approval request UUIDs | |
failure_reason |
string | Failure reason | |
target_status |
string: done, failed, blocked, cancelled |
yes | Terminal target attempt status |
TransitionTaskRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
target_status |
string: done, failed, cancelled |
yes | Terminal target task status |
TreeNodeItem
| Field | Type | Required | Description |
|---|---|---|---|
artifact_id |
string (uuid) | Artifact UUID | |
created_at |
string (date-time) | yes | Creation time |
creator_avatar_url |
string | Creator avatar URL | |
creator_id |
string | Creator principal ID | |
creator_name |
string | Creator display name | |
creator_type |
string: user, agent, team, system |
Creator entity type | |
external_ref |
string | External reference | |
id |
string (uuid) | yes | Tree node UUID |
kb_id |
string (uuid) | KB UUID | |
name |
string | yes | Node name |
node_type |
string: folder, page, file |
yes | Node type |
org_id |
string (uuid) | yes | Organization UUID |
page_id |
string (uuid) | Page UUID | |
parent_id |
string (uuid) | Parent node UUID | |
sort_order |
integer (int32) | yes | Sort order |
source_ref |
string | Source reference | |
updated_at |
string (date-time) | yes | Last update time |
TreeNodeWithChildrenItem
| Field | Type | Required | Description |
|---|---|---|---|
children |
array of TreeNodeWithChildrenItem |
yes | Nested children |
children_count |
integer (int32) | yes | Child count |
node |
TreeNodeItem |
yes | Tree node |
UnreadCountResult
| Field | Type | Required | Description |
|---|---|---|---|
unread |
integer (int64) | yes | Unread count |
UpdateAgentChannelCredentialsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
config |
object | yes | Updated channel form values keyed by field key. Sensitive values are forwarded to the agent runtime and are never persisted or logged by the platform. |
UpdateAgentModelRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
model |
string | yes |
UpdateAgentModelVisibilityRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
visible |
boolean | yes |
UpdateAgentPolicyRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
dm_allowlist |
array of string | Complete target DM allowlist (member UUIDs); omitted = not changed, [] = clear | |
dm_policy |
string: open, allowlist, owner |
DM access policy; omitted = not changed | |
group_allowlist |
array of string | Complete target group allowlist (conversation UUIDs); omitted = not changed, [] = clear | |
group_scope |
string: open, allowlist, disabled |
Group access scope; omitted = not changed |
UpdateAgentPolicyResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
change_id |
string | yes | Batch change ID; poll GET /api/v1/agents/{agent_member_id}/policy-changes/{change_id} for its outcome |
items |
array of string | yes | Items in this batch, in the fixed order dm_policy, dm_allowlist, group_scope, group_allowlist (only the ones the request carried) |
request_id |
string (uuid) | yes | Request trace ID |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: applying, applied, failed |
yes | Change status at write time; always applying on success (the agent has not confirmed it yet) |
UpdateConnectApplicationActionDefRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
encoding |
string | Request body encoding | |
headers |
object | Header template; non-empty replaces stored headers, empty leaves unchanged | |
input_schema |
string | JSON schema for action inputs | |
method |
string | HTTP method | |
request_spec |
any | Optional request_spec JSON object; present replaces the stored one (cannot be cleared via update). Validated by the platform | |
url_template |
string | URL template |
UpdateConnectApplicationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
api_key_header_name |
string | API key header/param name | |
api_key_location |
string | API key location: header or query | |
category |
string | Category | |
connector_kind |
string | Connector transport kind (read-only after create; accepted but not applied on update) | |
description |
string | Description | |
display_name |
string | Display name | |
icon_url |
string | Icon URL | |
is_enabled |
boolean | Whether the application is enabled | |
oauth_authorize_url |
string | OAuth authorize URL (unset leaves unchanged) | |
oauth_client_id |
string | OAuth client ID (unset leaves unchanged) | |
oauth_client_secret |
string | OAuth client secret (empty/absent leaves the stored secret unchanged; non-empty overwrites) | |
oauth_pkce |
boolean | Whether OAuth uses PKCE | |
oauth_scopes_default |
array of string | Default OAuth scopes (absent leaves unchanged; present replaces, empty clears) | |
oauth_token_auth_method |
string | OAuth token auth method: basic or post | |
oauth_token_body_format |
string | OAuth token body format: form or json | |
oauth_token_url |
string | OAuth token URL (unset leaves unchanged) |
UpdateConnectConnectionRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Connection display name |
mcp_headers |
array of ConnectMcpHeaderInput |
Full-replace custom-header set for a remote_http MCP connection: each {name, value, is_secret}. Omit to leave headers unchanged; send (even an empty array) to replace the full set. An is_secret=true entry with an empty value keeps the existing stored secret. Validated server-side. |
UpdateEventBindingRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
anchor_at |
string (date-time) | Interval phase anchor instant | |
authorization_card_interaction_id |
string (uuid) | ||
authorization_confirmation_message_id |
string | ||
authorization_proposal_message_id |
string | ||
cron_expr |
string | Five-field cron expression, required for cron schedules | |
expected_version |
integer (int64) | yes | Current binding version for optimistic concurrency control |
interval_seconds |
integer (int64) | Elapsed interval in seconds | |
lead_member_id |
string (uuid) | yes | Lead agent member UUID |
owner_member_id |
string (uuid) | Human Owner UUID; omitted defaults to the human caller, not the previous owner. Agent callers require an explicit human Owner; the server enforces authorization | |
project_member_additions |
array of string | Members added to spec.project_id atomically with this write: only lead_member_id and/or owner_member_id, each once. The acting human (caller, or the confirming human for Agent writes) needs project write access. Must be empty for the Inbox. A non-empty list also resumes an automation paused for LEAD_PROJECT_ACCESS_REQUIRED or OWNER_PROJECT_ACCESS_REQUIRED once every dependency validates. Where resume-on-save is enabled on the deployment, any save by the Owner (direct, or confirmed in chat) that passes every check resumes an automation paused for LEAD_PROJECT_ACCESS_REQUIRED, OWNER_PROJECT_ACCESS_REQUIRED, MEMBER_UNAVAILABLE, PRIVATE_LEAD_OWNER_CHANGED or PROJECT_UNAVAILABLE, with or without this list; never a manual pause, and an elapsed single run stays paused. Read enabled and pause_reason in the response | |
result_notification_policy |
string: every, failure_only, none |
Omitted preserves the current policy and migration notice; an explicit enum value clears the notice, even when unchanged. HTTP null is tolerated as omission | |
run_at |
string (date-time) | Once trigger instant | |
schedule_kind |
string: cron, once, interval |
Replacement schedule mode; omitted means cron | |
spec |
UpdateEventBindingSpec |
yes | Complete issue specification to replace the current configuration; an omitted knowledge base choice (knowledge_base_mode with knowledge_base_id) or unattached keeps the current one |
timezone |
string | yes | Required for full replacement, unlike create. IANA timezone, or an explicit empty string to apply no timezone; does not retain the previous timezone |
UpdateEventBindingSpec
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Issue description; at most 1500 Unicode code points; omitted or empty clears the current description | |
knowledge_base_id |
string (uuid) | Required exactly for knowledge_base_mode custom; must fit the project's scope (an organization project's automation cannot use a private knowledge base, a private one needs its owner's) | |
knowledge_base_mode |
string: project_default, custom, none |
Where runs store their outputs: project_default uses the project's knowledge base (for an unattached private automation, the Owner's personal private project's at run time), custom uses knowledge_base_id, none stores nothing in a knowledge base. Omitted on a create means project_default; an update that omits it (and knowledge_base_id) keeps the current choice, so send project_default to reset | |
project_id |
string (uuid) | Target project UUID; required unless unattached | |
title |
string | yes | Issue title; at most 200 Unicode code points |
unattached |
boolean | The automation belongs to no project. With project_id omitted, unattached_scope chooses where it runs: the organization Inbox, or the Owner's hidden private project (created on first use; needs the Owner's private workspace). An update may name the project an earlier read returned. Omitted on a create means attached; an update that omits it keeps the current attachment, so send false to attach an unattached automation to project_id | |
unattached_scope |
string: org, private |
With unattached and no project_id: org (default) or private. A private one is created only by its Owner, whose own Agent leads it and joins through project_member_additions |
UpdateGroupConversationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_media_id |
string | Avatar media UUID | |
description |
string | Group description | |
name |
string | Group name |
UpdateIssueRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Update issue description | |
priority |
string: low, medium, high |
Update issue priority | |
title |
string | Update issue title |
UpdateKBRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | KB description | |
icon |
string | KB icon | |
name |
string | KB name | |
set_description |
boolean | Set to true to apply description, or clear it when description is omitted | |
set_icon |
boolean | Set to true to apply icon, or clear it when icon is omitted | |
visibility |
string: open, closed, private |
KB visibility |
UpdateMeData
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL | |
contact_email |
string | UNVERIFIED contact email after the update; omitted when unset or just cleared. Never used for authentication or verification. | |
created_at |
string (date-time) | yes | Identity creation time |
display_name |
string | yes | Display name |
identity_id |
string (uuid) | yes | Identity UUID |
kind |
string: human, agent |
yes | Identity type |
locale |
string: en, zh |
Identity-level preferred language; omitted when unset | |
phone_cc |
string | Primary phone country calling code (digits only, no +); omitted when unset | |
phone_number |
string | Primary phone national number (without country code); omitted when unset |
UpdateMeRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL from POST /api/v1/avatars/uploads/finalize in the current organization, or "" to restore the default avatar | |
contact_email |
string | Update the UNVERIFIED contact email on the caller's own identity. Send a valid address to set it; send an empty string to CLEAR it. Omitting the field (or sending JSON null, which is indistinguishable from omitted) leaves the stored value unchanged. Invalid non-empty values are rejected with 400. This never becomes a login or verification address — see the contact_email field on the response. | |
display_name |
string | Update display name | |
locale |
string: en, zh |
Update identity-level preferred language (org independent) | |
phone_cc |
string | Update primary phone country calling code (digits only, no +, 1-4 digits). Must be sent together with phone_number. | |
phone_number |
string | Update primary phone national number (digits only, 4-15). Must be sent together with phone_cc. |
UpdateMemberDisplayNameData
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Org-level member display name |
UpdateMemberDisplayNameRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
display_name |
string | yes | Org-level member display name |
UpdateMemberRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL from POST /api/v1/avatars/uploads/finalize in this organization, or "" to restore the default avatar | |
display_name |
string | Change org-level member display name | |
role_id |
string (uuid) | Change member role (single-role model) | |
status |
string: active, suspended |
Change member status (active or suspended only; departed requires DELETE) |
UpdateMemberResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url |
string | Avatar URL | |
display_name |
string | yes | Display name |
identity_id |
string (uuid) | yes | Identity UUID |
joined_at |
string (date-time) | yes | When the member joined the org |
kind |
string: human, agent, system |
yes | Member type |
member_id |
string (uuid) | yes | Member UUID |
online_status |
string: online, offline, unknown |
Online status (unknown if it cannot be determined) | |
request_id |
string (uuid) | yes | Request trace ID |
role |
MemberRole |
yes | Current role after update (single-role model) |
server_time |
string (date-time) | yes | Server timestamp |
status |
string: active, suspended, departed |
yes | Member status |
UpdateOrganizationData
| Field | Type | Required | Description |
|---|---|---|---|
industry |
string | yes | Organization industry key; null when never chosen |
industry_other |
string | yes | Free-text supplement for industry=other; null otherwise |
name |
string | yes | Updated name |
org_id |
string (uuid) | yes | Organization UUID |
slug |
string | yes | Updated slug |
status |
string: active |
yes | Organization status |
UpdateOrganizationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
industry |
string: retail_ecom, b2b_trade, content_media, consumer_brand, logistics, manufacturing, other |
Update the organization industry key. Switching to a value other than 'other' clears industry_other. Existing agents are not renamed. | |
industry_other |
string | Update the free-text supplement; only valid when the resulting industry is 'other'. Blank clears it; omitted keeps the stored text while the industry stays 'other'. | |
name |
string | Update organization name | |
slug |
string | Update organization slug (globally unique) |
UpdatePageContentRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
auto_save |
boolean | yes | Whether this is an autosave update |
base_revision_id |
integer (int64) | Expected base revision ID | |
body |
string | yes | Page content body |
message |
string | Revision message |
UpdatePageMetadataRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | Page title |
UpdateProjectRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Update project description | |
knowledge_base_id |
string (uuid) | Update default knowledge base for new issues; existing issues retain their knowledge base | |
lead_member_id |
string (uuid) | Update lead member UUID | |
name |
string | Update project name |
UpdateSubConversationRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes | New display title; empty clears it. |
UpdateWebhookRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
authorization_card_interaction_id |
string (uuid) | ||
authorization_confirmation_message_id |
string | ||
authorization_proposal_message_id |
string | ||
event_filter |
string | Optional bounded CEL boolean expression over payload; empty matches all | |
expected_version |
integer (int64) | yes | |
lead_member_id |
string (uuid) | yes | |
owner_member_id |
string (uuid) | Human Owner UUID; omitted defaults to the human caller, not the previous owner. Agent callers require an explicit human Owner | |
project_member_additions |
array of string | Members added to spec.project_id atomically with this write: only lead_member_id and/or owner_member_id, each once. The acting human (caller, or the confirming human for Agent writes) needs project write access. Must be empty for the Inbox. A non-empty list also resumes an automation paused for LEAD_PROJECT_ACCESS_REQUIRED or OWNER_PROJECT_ACCESS_REQUIRED once every dependency validates. Where resume-on-save is enabled on the deployment, any save by the Owner (direct, or confirmed in chat) that passes every check resumes an automation paused for LEAD_PROJECT_ACCESS_REQUIRED, OWNER_PROJECT_ACCESS_REQUIRED, MEMBER_UNAVAILABLE, PRIVATE_LEAD_OWNER_CHANGED or PROJECT_UNAVAILABLE, with or without this list; never a manual pause, and an elapsed single run stays paused. Read enabled and pause_reason in the response | |
result_notification_policy |
string: every, failure_only, none |
Omitted preserves the current policy and migration notice; an explicit enum value clears the notice, even when unchanged. HTTP null is tolerated as omission | |
spec |
UpdateEventBindingSpec |
yes |
UsageCredentialMetadataBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
UsageCredentialMetadataData |
yes | |
request_id |
string | yes | |
server_time |
string (date-time) | yes |
UsageCredentialMetadataData
| Field | Type | Required | Description |
|---|---|---|---|
credential |
Credential |
yes |
UsageSnapshotDTO
| Field | Type | Required | Description |
|---|---|---|---|
agent_slots_total |
integer (int64) | yes | |
agent_slots_used |
integer (int64) | yes | |
credit_as_of |
string (date-time) | ||
credit_balance |
integer (int64) | yes | |
credit_breakdown |
CreditBreakdownDTO |
||
credit_pending |
integer (int64) | yes | |
enforcement_suspended |
boolean | yes | true when the org's LLM usage is currently stopped by the engine for non-payment |
members_total |
integer (int64) | yes | |
members_used |
integer (int64) | yes | |
outstanding_points |
integer (int64) | yes | Current charge debt awaiting deduction; credit_balance remains nonnegative |
paid_balance |
integer (int64) | yes | Purchase/subscription grant remaining (points) |
period_consumed_points |
integer (int64) | yes | Net points consumed this billing period; used% = consumed/(consumed+credit_balance) |
promo_balance |
integer (int64) | yes | Trial/promo grant remaining (points); during a trial this IS the trial remaining |
UsageSummaryBucketDTO
| Field | Type | Required | Description |
|---|---|---|---|
bucket_start |
string (date-time) | yes | Bucket start, truncated to the requested granularity (UTC) |
model |
string | yes | Resource/model the usage was metered against |
points_micro |
integer (int64) | yes | Billed points ×1e6 |
quantity |
integer (int64) | yes | Raw metered quantity, counted in the unit reported by unit (NOT always tokens) |
unit |
string | yes | Unit code for quantity: token | minute | request; empty = unit unknown (show the number without a unit, never guess one) |
usage_type |
string | yes | Usage-type code: request (one entry per request) | input|output|cache_read (per-token usage; these three appear only on earlier usage, current usage is reported as request) | agent_runtime_hourly (Agent runtime). Machine-readable; render an unknown code as-is. |
UsageSummaryDTO
| Field | Type | Required | Description |
|---|---|---|---|
buckets |
array of UsageSummaryBucketDTO |
yes |
UserConversationItem
| Field | Type | Required | Description |
|---|---|---|---|
conversation |
ConversationItem |
yes | Conversation |
has_unread_subconversations |
boolean | yes | Whether the caller has an unread message in at least one unarchived context sub-conversation under this conversation (the dot on its sub-conversation entry). Not included in unread_count; always false on observed rows. |
is_done |
boolean | Whether the conversation is marked as done; omitted for observed conversations | |
is_muted |
boolean | Whether the conversation is muted; omitted for observed conversations | |
is_observed |
boolean | yes | Whether this row is visible through observation |
is_pinned |
boolean | Whether the conversation is pinned; omitted for observed conversations | |
last_read_seq |
integer (int64) | Last read sequence; omitted for observed conversations | |
observed_member_ids |
array of string | yes | Observed member IDs that make this visible |
pin_order |
integer (int32) | Pin order; omitted for observed conversations | |
unread_count |
integer (int64) | yes | Unread count |
unread_mention |
string: none, direct, all |
yes | Unread @mention badge state. direct wins over all when both are unread; always none on observed rows. |
WebhookConfiguration
| Field | Type | Required | Description |
|---|---|---|---|
authorization_card_interaction_id |
string (uuid) | ||
authorization_confirmation_message_id |
string | ||
authorization_proposal_message_id |
string | ||
event_filter |
string | Optional bounded CEL boolean expression over payload; empty matches all | |
lead_member_id |
string (uuid) | yes | |
owner_member_id |
string (uuid) | Human Owner UUID; omitted defaults to the human caller. Agent callers require an explicit human Owner | |
project_member_additions |
array of string | Members added to spec.project_id atomically with this write: only lead_member_id and/or owner_member_id, each once. The acting human (caller, or the confirming human for Agent writes) needs project write access. Must be empty for the Inbox | |
result_notification_policy |
string: every, failure_only, none |
Final result DM policy; omitted webhook creates default to failure_only. HTTP null is tolerated as omission | |
spec |
UpdateEventBindingSpec |
yes |
WebhookCredential
| Field | Type | Required | Description |
|---|---|---|---|
binding |
EventBindingItem |
yes | |
credential_version |
integer (int64) | yes | |
event_filter |
string | yes | |
webhook_url |
string | yes | Secret URL returned only on creation, timer-to-webhook replacement, or rotation; never persist in browser storage |
WebhookCredentialResponseBody
| Field | Type | Required | Description |
|---|---|---|---|
data |
WebhookCredential |
yes | |
request_id |
string | yes | |
server_time |
string (date-time) | yes |
WebhookDeliveryItem
| Field | Type | Required | Description |
|---|---|---|---|
attempt_count |
integer (int32) | yes | |
created_issue_id |
string | ||
error_code |
string | ||
event_binding_id |
string | yes | |
id |
string | yes | |
occurrence_id |
string | ||
received_at |
string (date-time) | yes | |
replay_state |
string: held, replay, declined, excluded, expired, overflow |
Held-event replay state; omitted for a delivery that was never held. Only a delivery without one or with replay can be retried | |
status |
string | yes | Delivery processing state, not Agent execution result |
WebhookItem
| Field | Type | Required | Description |
|---|---|---|---|
binding |
EventBindingItem |
yes | |
credential_version |
integer (int64) | yes | |
event_filter |
string | yes |
WorkReferenceItem
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | Current Project description | |
id |
string (uuid) | yes | Stable work object UUID |
is_default |
boolean | Whether a Project is the organization default | |
kind |
string: project, issue |
yes | Referenced work object kind |
label |
string | yes | Current Project name or Issue title |
project_id |
string (uuid) | Parent Project UUID for an Issue | |
project_name |
string | Current parent Project name for an Issue | |
resource_uri |
string | yes | Canonical Project or Issue URI for message bodies |
status |
string | Current Project or Issue status |
WsTicketData
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string (date-time) | yes | Ticket expiry (30 seconds from issuance) |
ticket |
string | yes | One-time WebSocket ticket. Use as query parameter: ws://host/ws?ticket= |
