Для AI-агентов: markdown этой страницы — /docs/mcp-catalog.mdиндекс документации — /llms.txt
MCP: catalog
Обновлено
MCP: catalog
Это определения инструментов из текущего ToolRegistry, включая полные inputSchema/outputSchema, scope, required_scopes (ALL), risk и версию платформы. Наличие определения не означает, что инструмент уже установлен вашим хостом или разрешён вашим credential. Обновляйте tools/list после изменения бизнеса, readiness и прав. Progressive disclosure через load_domain/describe_tool и существующий meta-dispatch описаны в MCP-руководстве. Scopes и права применяются при вызове; risk не заменяет согласие и отдельные требования денежной операции. JSON ниже — схема, а не успешный результат вызова.
create_catalog_group
Create a catalog group for the active business. Returns its tenant seq_num.
{
"description": "Create a catalog group for the active business. Returns its tenant seq_num.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"icon_custom_emoji_id": {
"anyOf": [
{
"description": "Value for icon custom emoji id option.",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
{
"description": "Value for icon custom emoji id option.",
"type": "null"
}
],
"description": "Value for icon custom emoji id."
},
"is_active": {
"default": true,
"description": "Value for is active.",
"type": "boolean"
},
"is_public": {
"default": true,
"description": "Value for is public.",
"type": "boolean"
},
"sort": {
"default": 0,
"description": "Value for sort.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"style": {
"anyOf": [
{
"description": "Value for style option.",
"enum": [
"primary",
"success",
"danger"
],
"type": "string"
},
{
"description": "Value for style option.",
"type": "null"
}
],
"description": "Value for style."
},
"title": {
"description": "Value for title.",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"required": [
"title",
"sort",
"is_active",
"is_public"
],
"type": "object"
},
"name": "create_catalog_group",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write"
],
"risk": "write",
"scope": "catalog:write",
"title": "Create Catalog Group"
}delete_catalog_group
Delete a catalog group by tenant seq_num; assigned products remain.
{
"description": "Delete a catalog group by tenant seq_num; assigned products remain.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"seq_num": {
"description": "Value for seq num.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}
},
"required": [
"seq_num"
],
"type": "object"
},
"name": "delete_catalog_group",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write"
],
"risk": "destructive",
"scope": "catalog:write",
"title": "Delete Catalog Group"
}get_catalog
List all live catalog items (cursor-paginated; deleted excluded) with reach pair is_active/is_public: is_active:false = off, sold by nothing; both true = in the showcase, offer freely; is_public:false = link-only, never volunteer it. zone (ru/com) selects price presentation, default ru.
{
"description": "List all live catalog items (cursor-paginated; deleted excluded) with reach pair `is_active`/`is_public`: `is_active:false` = off, sold by nothing; both true = in the showcase, offer freely; `is_public:false` = link-only, never volunteer it. `zone` (ru/com) selects price presentation, default ru.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Value for cursor.",
"type": "string"
},
"filters": {
"additionalProperties": {},
"description": "Value for filters.",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"limit": {
"description": "Value for limit.",
"exclusiveMinimum": 0,
"maximum": 100,
"type": "integer"
},
"zone": {
"description": "Value for zone.",
"enum": [
"ru",
"com"
],
"type": "string"
}
},
"type": "object"
},
"name": "get_catalog",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"data": {
"items": {
"additionalProperties": false,
"properties": {
"available_providers": {
"items": {
"additionalProperties": false,
"properties": {
"currency": {
"minLength": 1,
"type": "string"
},
"min_charge": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
]
},
{
"type": "null"
}
]
},
"provider": {
"minLength": 1,
"type": "string"
},
"requires_postal_code": {
"type": "boolean"
}
},
"required": [
"provider",
"currency",
"min_charge",
"requires_postal_code"
],
"type": "object"
},
"type": "array"
},
"editable_config": {
"additionalProperties": false,
"properties": {
"editable_fields": {
"items": {
"type": "string"
},
"type": "array"
},
"etag": {
"type": "string"
}
},
"required": [
"etag",
"editable_fields"
],
"type": "object"
},
"is_active": {
"type": "boolean"
},
"is_public": {
"type": "boolean"
},
"item_type": {
"enum": [
"product",
"service",
"digital",
"delivery"
],
"type": "string"
},
"measurement_unit": {
"maxLength": 32,
"type": "string"
},
"prices": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"amount": {
"anyOf": [
{
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"type": "null"
}
]
},
"currency": {
"enum": [
"RUB",
"USD",
"EUR"
],
"type": "string"
},
"trial_amount": {
"anyOf": [
{
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"amount": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
]
},
"currency": {
"const": "XTR",
"type": "string"
},
"trial_amount": {
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"amount": {
"anyOf": [
{
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
{
"type": "null"
}
]
},
"currency": {
"enum": [
"USDT",
"TON",
"BTC",
"ETH",
"LTC",
"BNB",
"TRX",
"USDC"
],
"type": "string"
},
"trial_amount": {
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
}
]
},
"type": "array"
},
"requires_postal_code": {
"type": "boolean"
},
"seq_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"sku_code": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
},
"title_alt": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
}
},
"required": [
"seq_id",
"title",
"is_active",
"is_public",
"prices",
"item_type",
"sku_code",
"measurement_unit",
"requires_postal_code",
"updated_at"
],
"type": "object"
},
"type": "array"
},
"meta": {
"additionalProperties": false,
"properties": {
"estimated_total": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"limit": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"has_more",
"next_cursor",
"limit"
],
"type": "object"
},
"success": {
"const": true,
"type": "boolean"
}
},
"required": [
"success",
"data",
"meta"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"catalog:read"
],
"risk": "read",
"scope": "catalog:read",
"title": "Get Catalog"
}get_catalog_group
Read one catalog group by its seq_num.
{
"description": "Read one catalog group by its `seq_num`.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"seq_num": {
"description": "Value for seq num.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}
},
"required": [
"seq_num"
],
"type": "object"
},
"name": "get_catalog_group",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:read"
],
"risk": "read",
"scope": "catalog:read",
"title": "Get Catalog Group"
}get_catalog_item
Read one catalog item by seq_id; the response carries the etag you pass to update it. zone (ru/com) selects price presentation, default ru.
{
"description": "Read one catalog item by seq_id; the response carries the `etag` you pass to update it. `zone` (ru/com) selects price presentation, default ru.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"seq_id": {
"description": "Value for seq id.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"zone": {
"description": "Value for zone.",
"enum": [
"ru",
"com"
],
"type": "string"
}
},
"required": [
"seq_id"
],
"type": "object"
},
"name": "get_catalog_item",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:read"
],
"risk": "read",
"scope": "catalog:read",
"title": "Get Catalog Item"
}list_catalog_groups
List catalog groups with their seq_num, reach state, sort order and item count.
{
"description": "List catalog groups with their `seq_num`, reach state, sort order and item count.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_catalog_groups",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:read"
],
"risk": "read",
"scope": "catalog:read",
"title": "List Catalog Groups"
}onboarding_execute_first_payment
Execute the owner-approved preparation receipt, save its exact catalog price and send a real purchase card. Card delivery does not confirm payment.
{
"description": "Execute the owner-approved preparation receipt, save its exact catalog price and send a real purchase card. Card delivery does not confirm payment.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"payload_hash": {
"description": "Value for payload hash.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"preparation_id": {
"description": "Value for preparation id.",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"preparation_id",
"payload_hash"
],
"type": "object"
},
"name": "onboarding_execute_first_payment",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"active_slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"billing": {
"additionalProperties": false,
"properties": {
"auto_renew": {
"type": "boolean"
},
"grace_until": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"next_charge_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"period_end": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"plan": {
"type": "string"
},
"status": {
"enum": [
"free",
"trial",
"active",
"grace",
"expired",
"cancelled"
],
"type": "string"
},
"trial_ends_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"trial_started_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"plan",
"period_end",
"auto_renew",
"next_charge_at"
],
"type": "object"
},
"body": {
"additionalProperties": false,
"properties": {
"card_delivery_state": {
"enum": [
"pending",
"sent"
],
"type": "string"
},
"product_seq_num": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"title": {
"type": "string"
}
},
"required": [
"product_seq_num",
"title",
"card_delivery_state"
],
"type": "object"
},
"journey": {
"additionalProperties": false,
"properties": {
"ai_preferences": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"app": {
"enum": [
"claude",
"chatgpt",
"codex",
"claude-code",
"other"
],
"type": "string"
},
"confirmed_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"device": {
"enum": [
"desktop",
"web",
"phone"
],
"type": "string"
},
"other_app": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"questions_revision": {
"const": 1,
"type": "number"
},
"subscription": {
"enum": [
"paid",
"free"
],
"type": "string"
}
},
"required": [
"device",
"app",
"subscription",
"questions_revision",
"confirmed_at"
],
"type": "object"
},
{
"type": "null"
}
]
},
"bonus_state": {
"enum": [
"not_eligible",
"pending",
"settled"
],
"type": "string"
},
"completed": {
"type": "boolean"
},
"completed_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"decisions": {
"additionalProperties": false,
"properties": {
"first_payment_deferred_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"tariff_deferred_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first_payment_deferred_at",
"tariff_deferred_at"
],
"type": "object"
},
"first_payment": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"amount": {
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
"currency": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"is_active": {
"const": true,
"type": "boolean"
},
"payload_hash": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"phase": {
"enum": [
"accepted",
"price_committed",
"card_pending",
"sent"
],
"type": "string"
},
"preparation_id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"product_seq_num": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"provider": {
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"purchase_zone": {
"enum": [
"ru",
"com"
],
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"phase",
"product_seq_num",
"title",
"provider",
"amount",
"currency",
"purchase_zone",
"is_active",
"preparation_id",
"payload_hash"
],
"type": "object"
},
{
"type": "null"
}
]
},
"infrastructure_ready": {
"type": "boolean"
},
"provider_readiness": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"checked_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"checkout_creation": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"configuration_confirmation_token": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
]
},
"configuration_fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"limitations": {
"items": {
"type": "string"
},
"type": "array"
},
"live_payment": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"next_action": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"production_environment": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"provider": {
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"ready": {
"type": "boolean"
},
"webhook_configuration": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"webhook_configuration_assurance": {
"anyOf": [
{
"enum": [
"provider_api",
"signed_delivery",
"owner_attested"
],
"type": "string"
},
{
"type": "null"
}
]
},
"webhook_delivery": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
}
},
"required": [
"provider",
"configuration_fingerprint",
"checked_at",
"ready",
"authentication",
"production_environment",
"checkout_creation",
"webhook_configuration",
"webhook_delivery",
"live_payment",
"limitations",
"next_action"
],
"type": "object"
},
{
"type": "null"
}
]
},
"revision": {
"const": 1,
"type": "number"
},
"rewards": {
"additionalProperties": false,
"properties": {
"tokens_granted": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"tokens_remaining": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"trial_days": {
"minimum": 0,
"type": "number"
}
},
"required": [
"tokens_granted",
"tokens_remaining",
"trial_days"
],
"type": "object"
},
"test_completed": {
"type": "boolean"
},
"test_required": {
"type": "boolean"
}
},
"required": [
"revision",
"completed",
"completed_at",
"infrastructure_ready",
"test_required",
"test_completed",
"bonus_state",
"ai_preferences",
"decisions",
"provider_readiness"
],
"type": "object"
},
"next_action": {
"additionalProperties": false,
"properties": {
"collect": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"type": "string"
},
"hint": {
"type": "string"
}
},
"required": [
"field",
"hint"
],
"type": "object"
},
"type": "array"
},
"execution": {
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"business_slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"continue_with": {
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"say_to_user": {
"minLength": 1,
"type": "string"
},
"tool": {
"anyOf": [
{
"const": "get_onboarding_state",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tool",
"arguments"
],
"type": "object"
},
"executor": {
"enum": [
"agent",
"owner",
"server"
],
"type": "string"
},
"prepared_execute": {
"additionalProperties": false,
"properties": {
"arguments_fields": {
"prefixItems": [
{
"const": "preparation_id",
"type": "string"
},
{
"const": "payload_hash",
"type": "string"
}
],
"type": "array"
},
"requires_human_review": {
"const": true,
"type": "boolean"
},
"tool": {
"const": "onboarding_execute_first_payment",
"type": "string"
}
},
"required": [
"tool",
"requires_human_review",
"arguments_fields"
],
"type": "object"
},
"recovery": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"say_to_user": {
"type": "string"
},
"tool": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tool",
"arguments",
"say_to_user"
],
"type": "object"
},
{
"type": "null"
}
]
},
"requires": {
"items": {
"type": "string"
},
"type": "array"
},
"step": {
"minLength": 1,
"type": "string"
},
"success": {
"additionalProperties": false,
"properties": {
"fact": {
"minLength": 1,
"type": "string"
}
},
"required": [
"fact"
],
"type": "object"
},
"tool": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"wait": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"retry_after_seconds": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"stop_when": {
"minLength": 1,
"type": "string"
}
},
"required": [
"retry_after_seconds",
"stop_when"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"business_slug",
"step",
"executor",
"tool",
"arguments",
"requires",
"success",
"wait",
"recovery",
"continue_with"
],
"type": "object"
},
"goal": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_blocked",
"infrastructure_ready",
"quest_product_pending",
"quest_product_ready",
"quest_product_failed",
"payment_provider_alive",
"payment_provider_failed",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free",
"address_new_business",
"entry_choose_business",
"entry_work_or_create",
"infrastructure_ready_nth_bot"
],
"type": "string"
},
"media": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"video",
"image_steps"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
"say_to_user": {
"type": "string"
},
"switch_to": {
"type": "string"
},
"wait_for": {
"additionalProperties": false,
"properties": {
"event": {
"type": "string"
},
"retry_after_seconds": {
"minimum": 0,
"type": "number"
}
},
"required": [
"event"
],
"type": "object"
}
},
"required": [
"goal",
"say_to_user",
"collect"
],
"type": "object"
},
"owner_onboardings": {
"items": {
"additionalProperties": false,
"properties": {
"slug": {
"type": "string"
},
"stage": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_ready",
"quest_1",
"quest_2",
"warmup",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free"
],
"type": "string"
}
},
"required": [
"slug",
"stage"
],
"type": "object"
},
"type": "array"
},
"stage": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_ready",
"quest_1",
"quest_2",
"warmup",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free"
],
"type": "string"
},
"status": {
"enum": [
"todo",
"in_progress",
"waiting_owner",
"blocked",
"done"
],
"type": "string"
},
"tenant": {
"additionalProperties": false,
"properties": {
"bot_username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"slug",
"bot_username"
],
"type": "object"
}
},
"required": [
"active_slug",
"tenant",
"owner_onboardings",
"stage",
"status",
"next_action",
"body"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write",
"payments:config"
],
"risk": "money",
"scope": "catalog:write",
"title": "Onboarding Execute First Payment"
}onboarding_prepare_first_payment
Prepare a paid version of the delivered test product and show its exact price and provider for owner approval. This does not charge money.
{
"description": "Prepare a paid version of the delivered test product and show its exact price and provider for owner approval. This does not charge money.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"amount": {
"description": "Value for amount.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"currency": {
"description": "Value for currency.",
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"product_seq_num": {
"description": "Value for product seq num.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"provider": {
"description": "Value for provider.",
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"purchase_zone": {
"description": "Value for purchase zone.",
"enum": [
"ru",
"com"
],
"type": "string"
}
},
"required": [
"product_seq_num",
"provider",
"amount",
"currency"
],
"type": "object"
},
"name": "onboarding_prepare_first_payment",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"active_slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"billing": {
"additionalProperties": false,
"properties": {
"auto_renew": {
"type": "boolean"
},
"grace_until": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"next_charge_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"period_end": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"plan": {
"type": "string"
},
"status": {
"enum": [
"free",
"trial",
"active",
"grace",
"expired",
"cancelled"
],
"type": "string"
},
"trial_ends_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"trial_started_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"plan",
"period_end",
"auto_renew",
"next_charge_at"
],
"type": "object"
},
"body": {
"additionalProperties": false,
"properties": {
"amount": {
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
"currency": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"expires_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"is_active": {
"const": true,
"type": "boolean"
},
"payload_hash": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"preparation_id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"product_seq_num": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"provider": {
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"purchase_zone": {
"enum": [
"ru",
"com"
],
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"product_seq_num",
"provider",
"amount",
"currency",
"purchase_zone",
"is_active",
"preparation_id",
"payload_hash",
"expires_at",
"title"
],
"type": "object"
},
"journey": {
"additionalProperties": false,
"properties": {
"ai_preferences": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"app": {
"enum": [
"claude",
"chatgpt",
"codex",
"claude-code",
"other"
],
"type": "string"
},
"confirmed_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"device": {
"enum": [
"desktop",
"web",
"phone"
],
"type": "string"
},
"other_app": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"questions_revision": {
"const": 1,
"type": "number"
},
"subscription": {
"enum": [
"paid",
"free"
],
"type": "string"
}
},
"required": [
"device",
"app",
"subscription",
"questions_revision",
"confirmed_at"
],
"type": "object"
},
{
"type": "null"
}
]
},
"bonus_state": {
"enum": [
"not_eligible",
"pending",
"settled"
],
"type": "string"
},
"completed": {
"type": "boolean"
},
"completed_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"decisions": {
"additionalProperties": false,
"properties": {
"first_payment_deferred_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
},
"tariff_deferred_at": {
"anyOf": [
{
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first_payment_deferred_at",
"tariff_deferred_at"
],
"type": "object"
},
"first_payment": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"amount": {
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
"currency": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"is_active": {
"const": true,
"type": "boolean"
},
"payload_hash": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"phase": {
"enum": [
"accepted",
"price_committed",
"card_pending",
"sent"
],
"type": "string"
},
"preparation_id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"product_seq_num": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"provider": {
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"purchase_zone": {
"enum": [
"ru",
"com"
],
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"phase",
"product_seq_num",
"title",
"provider",
"amount",
"currency",
"purchase_zone",
"is_active",
"preparation_id",
"payload_hash"
],
"type": "object"
},
{
"type": "null"
}
]
},
"infrastructure_ready": {
"type": "boolean"
},
"provider_readiness": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"checked_at": {
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"checkout_creation": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"configuration_confirmation_token": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
]
},
"configuration_fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"limitations": {
"items": {
"type": "string"
},
"type": "array"
},
"live_payment": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"next_action": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"production_environment": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"provider": {
"enum": [
"robokassa",
"yookassa",
"stars",
"cryptobot",
"stripe",
"paypal",
"paddle",
"tinkoff",
"prodamus"
],
"type": "string"
},
"ready": {
"type": "boolean"
},
"webhook_configuration": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
},
"webhook_configuration_assurance": {
"anyOf": [
{
"enum": [
"provider_api",
"signed_delivery",
"owner_attested"
],
"type": "string"
},
{
"type": "null"
}
]
},
"webhook_delivery": {
"enum": [
"verified",
"failed",
"unknown"
],
"type": "string"
}
},
"required": [
"provider",
"configuration_fingerprint",
"checked_at",
"ready",
"authentication",
"production_environment",
"checkout_creation",
"webhook_configuration",
"webhook_delivery",
"live_payment",
"limitations",
"next_action"
],
"type": "object"
},
{
"type": "null"
}
]
},
"revision": {
"const": 1,
"type": "number"
},
"rewards": {
"additionalProperties": false,
"properties": {
"tokens_granted": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"tokens_remaining": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"trial_days": {
"minimum": 0,
"type": "number"
}
},
"required": [
"tokens_granted",
"tokens_remaining",
"trial_days"
],
"type": "object"
},
"test_completed": {
"type": "boolean"
},
"test_required": {
"type": "boolean"
}
},
"required": [
"revision",
"completed",
"completed_at",
"infrastructure_ready",
"test_required",
"test_completed",
"bonus_state",
"ai_preferences",
"decisions",
"provider_readiness"
],
"type": "object"
},
"next_action": {
"additionalProperties": false,
"properties": {
"collect": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"type": "string"
},
"hint": {
"type": "string"
}
},
"required": [
"field",
"hint"
],
"type": "object"
},
"type": "array"
},
"execution": {
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"business_slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"continue_with": {
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"say_to_user": {
"minLength": 1,
"type": "string"
},
"tool": {
"anyOf": [
{
"const": "get_onboarding_state",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tool",
"arguments"
],
"type": "object"
},
"executor": {
"enum": [
"agent",
"owner",
"server"
],
"type": "string"
},
"prepared_execute": {
"additionalProperties": false,
"properties": {
"arguments_fields": {
"prefixItems": [
{
"const": "preparation_id",
"type": "string"
},
{
"const": "payload_hash",
"type": "string"
}
],
"type": "array"
},
"requires_human_review": {
"const": true,
"type": "boolean"
},
"tool": {
"const": "onboarding_execute_first_payment",
"type": "string"
}
},
"required": [
"tool",
"requires_human_review",
"arguments_fields"
],
"type": "object"
},
"recovery": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"arguments": {
"additionalProperties": {},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"say_to_user": {
"type": "string"
},
"tool": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tool",
"arguments",
"say_to_user"
],
"type": "object"
},
{
"type": "null"
}
]
},
"requires": {
"items": {
"type": "string"
},
"type": "array"
},
"step": {
"minLength": 1,
"type": "string"
},
"success": {
"additionalProperties": false,
"properties": {
"fact": {
"minLength": 1,
"type": "string"
}
},
"required": [
"fact"
],
"type": "object"
},
"tool": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"wait": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"retry_after_seconds": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"stop_when": {
"minLength": 1,
"type": "string"
}
},
"required": [
"retry_after_seconds",
"stop_when"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"business_slug",
"step",
"executor",
"tool",
"arguments",
"requires",
"success",
"wait",
"recovery",
"continue_with"
],
"type": "object"
},
"goal": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_blocked",
"infrastructure_ready",
"quest_product_pending",
"quest_product_ready",
"quest_product_failed",
"payment_provider_alive",
"payment_provider_failed",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free",
"address_new_business",
"entry_choose_business",
"entry_work_or_create",
"infrastructure_ready_nth_bot"
],
"type": "string"
},
"media": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"video",
"image_steps"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"kind",
"url"
],
"type": "object"
},
"say_to_user": {
"type": "string"
},
"switch_to": {
"type": "string"
},
"wait_for": {
"additionalProperties": false,
"properties": {
"event": {
"type": "string"
},
"retry_after_seconds": {
"minimum": 0,
"type": "number"
}
},
"required": [
"event"
],
"type": "object"
}
},
"required": [
"goal",
"say_to_user",
"collect"
],
"type": "object"
},
"owner_onboardings": {
"items": {
"additionalProperties": false,
"properties": {
"slug": {
"type": "string"
},
"stage": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_ready",
"quest_1",
"quest_2",
"warmup",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free"
],
"type": "string"
}
},
"required": [
"slug",
"stage"
],
"type": "object"
},
"type": "array"
},
"stage": {
"enum": [
"address",
"site",
"bot",
"supergroups_create",
"supergroups_admin",
"supergroups_confirm",
"infrastructure",
"infrastructure_ready",
"quest_1",
"quest_2",
"warmup",
"quest_product",
"quest_purchase",
"payments",
"first_payment",
"ai_preferences",
"finish",
"completed",
"tariff",
"paid",
"free"
],
"type": "string"
},
"status": {
"enum": [
"todo",
"in_progress",
"waiting_owner",
"blocked",
"done"
],
"type": "string"
},
"tenant": {
"additionalProperties": false,
"properties": {
"bot_username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"slug",
"bot_username"
],
"type": "object"
}
},
"required": [
"active_slug",
"tenant",
"owner_onboardings",
"stage",
"status",
"next_action",
"body"
],
"type": "object"
},
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write",
"payments:config"
],
"risk": "money",
"scope": "catalog:write",
"title": "Onboarding Prepare First Payment"
}update_catalog_group
Update a catalog group by tenant seq_num, using its updated_at as if_match.
{
"description": "Update a catalog group by tenant seq_num, using its updated_at as if_match.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"icon_custom_emoji_id": {
"anyOf": [
{
"description": "Value for icon custom emoji id option.",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
{
"description": "Value for icon custom emoji id option.",
"type": "null"
}
],
"description": "Value for icon custom emoji id."
},
"if_match": {
"description": "Value for if match.",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"type": "string"
},
"is_active": {
"description": "Value for is active.",
"type": "boolean"
},
"is_public": {
"description": "Value for is public.",
"type": "boolean"
},
"seq_num": {
"description": "Value for seq num.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"sort": {
"description": "Value for sort.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"style": {
"anyOf": [
{
"description": "Value for style option.",
"enum": [
"primary",
"success",
"danger"
],
"type": "string"
},
{
"description": "Value for style option.",
"type": "null"
}
],
"description": "Value for style."
},
"title": {
"description": "Value for title.",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"required": [
"seq_num",
"if_match"
],
"type": "object"
},
"name": "update_catalog_group",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write"
],
"risk": "write",
"scope": "catalog:write",
"title": "Update Catalog Group"
}update_catalog_item
Patch a catalog item (sparse — omitted fields are untouched). Requires etag for optimistic concurrency and idempotency_key for durable receipt replay. A nonempty patch returns its canonical committed receipt identically on first success and exact replay. Use get_catalog_item for the current RU or COM price presentation and payment-provider availability. Optional zone selects that current presentation for an empty no-op patch; omitted defaults to RU. To configure selectable POS modifiers, patch the canonical nested variants object; retained keys are stable addresses, so an illegal key rewrite is rejected by the canonical writer. Reach is two INDEPENDENT booleans you may patch separately: is_active:false switches the item off entirely (purchasable by nothing); is_public:false takes it out of the showcase and storefront while it stays fully payable through its direct link. To configure a booking service, patch nested booking: enabled, mode (hourly/daily), duration_value, buffer_minutes, and resource_seq_nums.
{
"description": "Patch a catalog item (sparse — omitted fields are untouched). Requires `etag` for optimistic concurrency and `idempotency_key` for durable receipt replay. A nonempty patch returns its canonical committed receipt identically on first success and exact replay. Use `get_catalog_item` for the current RU or COM price presentation and payment-provider availability. Optional `zone` selects that current presentation for an empty no-op patch; omitted defaults to RU. To configure selectable POS modifiers, patch the canonical nested `variants` object; retained keys are stable addresses, so an illegal key rewrite is rejected by the canonical writer. Reach is two INDEPENDENT booleans you may patch separately: `is_active:false` switches the item off entirely (purchasable by nothing); `is_public:false` takes it out of the showcase and storefront while it stays fully payable through its direct link. To configure a booking service, patch nested `booking`: `enabled`, `mode` (`hourly`/`daily`), `duration_value`, `buffer_minutes`, and `resource_seq_nums`.",
"domain": "catalog",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bot": {
"description": "Optional slug of the bot you expect to act on (get_active_bot). If the active bot differs, the call is refused with ACTIVE_BOT_CHANGED and nothing runs.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"etag": {
"description": "Value for etag.",
"minLength": 1,
"type": "string"
},
"idempotency_key": {
"description": "Value for idempotency key.",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"patch": {
"additionalProperties": false,
"description": "Value for patch.",
"properties": {
"booking": {
"additionalProperties": false,
"description": "Value for booking.",
"properties": {
"buffer_minutes": {
"description": "Value for buffer minutes.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"duration_value": {
"anyOf": [
{
"description": "Value for duration value option.",
"pattern": "^\\d+(\\.\\d{1,8})?$",
"type": "string"
},
{
"description": "Value for duration value option.",
"type": "null"
}
],
"description": "Value for duration value."
},
"enabled": {
"description": "Value for enabled.",
"type": "boolean"
},
"mode": {
"description": "Value for mode.",
"enum": [
"hourly",
"daily"
],
"type": "string"
},
"resource_seq_nums": {
"description": "Value for resource seq nums.",
"items": {
"description": "Value for resource seq nums item.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"description": {
"description": "Value for description.",
"type": "string"
},
"description_alt": {
"description": "Value for description alt.",
"type": "string"
},
"intl_price_includes_tax": {
"anyOf": [
{
"description": "Value for intl price includes tax option.",
"type": "boolean"
},
{
"description": "Value for intl price includes tax option.",
"type": "null"
}
],
"description": "Value for intl price includes tax."
},
"intl_tax_rate_percent": {
"anyOf": [
{
"description": "Value for intl tax rate percent option.",
"maximum": 100,
"minimum": 0,
"multipleOf": 0.01,
"type": "number"
},
{
"description": "Value for intl tax rate percent option.",
"type": "null"
}
],
"description": "Value for intl tax rate percent."
},
"is_active": {
"description": "Value for is active.",
"type": "boolean"
},
"is_public": {
"description": "Value for is public.",
"type": "boolean"
},
"item_type": {
"description": "Value for item type.",
"enum": [
"product",
"service",
"digital",
"delivery"
],
"type": "string"
},
"measurement_unit": {
"description": "Value for measurement unit.",
"maxLength": 32,
"type": "string"
},
"mediaRefs": {
"description": "Value for media Refs.",
"items": {
"additionalProperties": false,
"description": "Value for media Refs item.",
"properties": {
"caption": {
"description": "Value for caption.",
"maxLength": 1024,
"type": "string"
},
"captionEntities": {
"description": "Value for caption Entities.",
"items": {
"additionalProperties": false,
"description": "Value for caption Entities item.",
"properties": {
"custom_emoji_id": {
"description": "Value for custom emoji id.",
"type": "string"
},
"language": {
"description": "Value for language.",
"type": "string"
},
"length": {
"description": "Value for length.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"offset": {
"description": "Value for offset.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Value for type.",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"spoiler",
"blockquote",
"expandable_blockquote",
"code",
"pre",
"text_link",
"text_mention",
"custom_emoji"
],
"type": "string"
},
"url": {
"description": "Value for url.",
"type": "string"
},
"user": {
"additionalProperties": false,
"description": "Value for user.",
"properties": {
"firstName": {
"description": "Value for first Name.",
"type": "string"
},
"id": {
"description": "Value for id.",
"pattern": "^-?\\d+$",
"type": "string"
},
"lastName": {
"description": "Value for last Name.",
"type": "string"
},
"username": {
"description": "Value for username.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"type",
"offset",
"length"
],
"type": "object"
},
"type": "array"
},
"captionHtml": {
"description": "Value for caption Html.",
"maxLength": 16384,
"minLength": 1,
"type": "string"
},
"expectedSizeBytes": {
"description": "Value for expected Size Bytes.",
"exclusiveMinimum": 0,
"maximum": 4294967296,
"type": "integer"
},
"generatedFileName": {
"description": "Value for generated File Name.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"kind": {
"description": "Value for kind.",
"enum": [
"voice",
"audio",
"video_note"
],
"type": "string"
},
"mediaRef": {
"description": "Value for media Ref.",
"maxLength": 512,
"pattern": "^media-ingress\\/v1\\/[a-f0-9]{64}\\/[A-Za-z0-9_-]{16,128}\\/objects\\/[a-z][a-z0-9-]{0,63}\\/[a-f0-9]{64}\\/[a-f0-9]{24}\\.blob$",
"type": "string"
},
"mimeType": {
"description": "Value for mime Type.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"sha256": {
"description": "Value for sha256.",
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"type": {
"description": "Value for type.",
"enum": [
"photo",
"video",
"document"
],
"type": "string"
}
},
"required": [
"type",
"mediaRef",
"expectedSizeBytes",
"sha256",
"mimeType"
],
"type": "object"
},
"maxItems": 10,
"type": "array"
},
"prices": {
"description": "Value for prices.",
"items": {
"description": "Value for prices item.",
"oneOf": [
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"description": "Value for currency.",
"enum": [
"RUB",
"USD",
"EUR"
],
"type": "string"
},
"trial_amount": {
"anyOf": [
{
"description": "Value for trial amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,2})?$",
"type": "string"
},
{
"description": "Value for trial amount option.",
"type": "null"
}
],
"description": "Value for trial amount."
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"const": "XTR",
"description": "Value for currency.",
"type": "string"
},
"trial_amount": {
"description": "Value for trial amount.",
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Value for prices item option.",
"properties": {
"amount": {
"anyOf": [
{
"description": "Value for amount option.",
"maxLength": 32,
"pattern": "^\\d+(?:\\.\\d{1,8})?$",
"type": "string"
},
{
"description": "Value for amount option.",
"type": "null"
}
],
"description": "Value for amount."
},
"currency": {
"description": "Value for currency.",
"enum": [
"USDT",
"TON",
"BTC",
"ETH",
"LTC",
"BNB",
"TRX",
"USDC"
],
"type": "string"
},
"trial_amount": {
"description": "Value for trial amount.",
"type": "null"
}
},
"required": [
"currency",
"amount",
"trial_amount"
],
"type": "object"
}
]
},
"type": "array"
},
"requires_postal_code": {
"description": "Value for requires postal code.",
"type": "boolean"
},
"ru_price_includes_tax": {
"anyOf": [
{
"description": "Value for ru price includes tax option.",
"type": "boolean"
},
{
"description": "Value for ru price includes tax option.",
"type": "null"
}
],
"description": "Value for ru price includes tax."
},
"ru_vat_rate": {
"anyOf": [
{
"description": "Value for ru vat rate option.",
"enum": [
"none",
"vat_0",
"vat_5",
"vat_7",
"vat_10",
"vat_20",
"vat_22"
],
"type": "string"
},
{
"description": "Value for ru vat rate option.",
"type": "null"
}
],
"description": "Value for ru vat rate."
},
"sku_code": {
"anyOf": [
{
"description": "Value for sku code option.",
"maxLength": 64,
"type": "string"
},
{
"description": "Value for sku code option.",
"type": "null"
}
],
"description": "Value for sku code."
},
"title": {
"description": "Value for title.",
"type": "string"
},
"title_alt": {
"description": "Value for title alt.",
"type": "string"
},
"trial": {
"additionalProperties": false,
"description": "Value for trial.",
"properties": {
"duration_days": {
"anyOf": [
{
"description": "Value for duration days option.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"description": "Value for duration days option.",
"type": "null"
}
],
"description": "Value for duration days."
},
"enabled": {
"description": "Value for enabled.",
"type": "boolean"
}
},
"type": "object"
},
"variants": {
"additionalProperties": false,
"description": "Value for variants.",
"properties": {
"attributes": {
"description": "Value for attributes.",
"items": {
"additionalProperties": false,
"description": "Value for attributes item.",
"properties": {
"key": {
"description": "Value for key.",
"pattern": "^[a-z0-9_]{1,16}$",
"type": "string"
},
"max": {
"description": "Value for max.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"name": {
"description": "Value for name.",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"options": {
"description": "Value for options.",
"items": {
"additionalProperties": false,
"description": "Value for options item.",
"properties": {
"is_available": {
"default": true,
"description": "Value for is available.",
"type": "boolean"
},
"is_deferred": {
"description": "Value for is deferred.",
"type": "boolean"
},
"key": {
"description": "Value for key.",
"pattern": "^[a-z0-9_]{1,16}$",
"type": "string"
},
"label": {
"description": "Value for label.",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"modifiers": {
"additionalProperties": false,
"description": "Value for modifiers.",
"properties": {
"eur": {
"description": "Value for eur.",
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$",
"type": "string"
},
"rub": {
"description": "Value for rub.",
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$",
"type": "string"
},
"stars": {
"description": "Value for stars.",
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": "string"
},
"usd": {
"description": "Value for usd.",
"pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$",
"type": "string"
}
},
"type": "object"
},
"requires_delivery": {
"description": "Value for requires delivery.",
"type": "boolean"
}
},
"required": [
"key",
"label",
"is_available"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"required": {
"default": false,
"description": "Value for required.",
"type": "boolean"
},
"select": {
"description": "Value for select.",
"enum": [
"single",
"multi"
],
"type": "string"
}
},
"required": [
"key",
"name",
"select",
"required",
"options"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"attributes"
],
"type": "object"
}
},
"type": "object"
},
"seq_id": {
"description": "Value for seq id.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"zone": {
"description": "Value for zone.",
"enum": [
"ru",
"com"
],
"type": "string"
}
},
"required": [
"seq_id",
"etag",
"idempotency_key",
"patch"
],
"type": "object"
},
"name": "update_catalog_item",
"outputSchema": null,
"platform_version": "1.0.19",
"required_scopes": [
"catalog:write"
],
"risk": "write",
"scope": "catalog:write",
"title": "Update Catalog Item"
}