Справочник API

BatchError#

BatchOperation#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

BatchRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "operations": [
        {
            "data": {
                "title": "Заметка",
                "type": "text"
            },
            "id": "abc",
            "op": "put"
        },
        {
            "data": {
                "available": false
            },
            "id": "def",
            "op": "patch"
        },
        {
            "id": "old-1",
            "op": "delete"
        }
    ]
}

BatchResponse#

Пример

{
    "results": [
        {
            "id": "abc",
            "ok": true,
            "status": "queued"
        },
        {
            "error": {
                "code": "not_found",
                "message": "Объект не найден"
            },
            "id": "def",
            "ok": false
        }
    ]
}

BatchResult#

EndUserIds#

Идентификаторы конечного пользователя (ТЗ §8): хотя бы одно поле.

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "anonymous_id": "b7f3c9",
    "user_id": "u-42"
}

ErrorInfo#

ErrorResponse#

Пример

{
    "error": {
        "code": "validation_failed",
        "details": [
            {
                "code": "invalid_url",
                "field": "media[0].url",
                "message": "допустим только адрес https"
            }
        ],
        "message": "Поля не прошли проверку"
    }
}

EventIn#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "id": "evt-1001",
    "item": "v-123",
    "occurred_at": "2026-09-14T12:00:00.250Z",
    "position": 3,
    "recommendation_id": "01J8Z3K4M5N6P7Q8R9S0T1V2W3",
    "surface": "feed",
    "type": "watch",
    "user": {
        "user_id": "u-42"
    },
    "value": 184
}

EventRejection#

EventTypeOut#

EventTypesResponse#

Тип: EventTypeOut[]

Пример

[
    {
        "code": "view",
        "dedup_window_sec": 86400,
        "hides_item": false,
        "is_active": true,
        "is_goal": false,
        "is_impression": false,
        "is_open": true,
        "is_purchase": false,
        "mode": "fact",
        "suppress_similar_days": 0,
        "title": "Открытие",
        "value_kind": "none",
        "weight": 0.2
    }
]

EventsRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

EventsResponse#

Пример

{
    "accepted": 998,
    "duplicates": 1,
    "rejected": [
        {
            "code": "unknown_item",
            "id": "evt-1018",
            "index": 17
        }
    ]
}

FrameOut#

HealthResponse#

ItemDeleteResponse#

Пример

{
    "deleted": true,
    "id": "abc"
}

ItemDetail#

ItemListEntry#

ItemListResponse#

Пример

{
    "items": [
        {
            "available": true,
            "deleted": false,
            "id": "abc",
            "status": "ready",
            "updated_at": "2026-09-14T12:00:00.123Z"
        }
    ]
}

ItemPatchRequest#

Частичное обновление: переданные поля заменяются, null очищает поле, кроме media и available; type не меняется.

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "available": false
}

ItemPutRequest#

Объект целиком. Непереданные поля очищаются.

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "author": "channel-42",
    "available": true,
    "description": "Обзор городских моделей",
    "media": [
        {
            "kind": "video",
            "url": "https://cdn.example.ru/abc.mp4",
            "version": "1"
        }
    ],
    "properties": {
        "category": "sport"
    },
    "published_at": "2026-09-14T12:00:00Z",
    "title": "Как выбрать велосипед",
    "type": "video",
    "url": "https://example.ru/v/abc"
}

ItemWriteResponse#

Пример

{
    "available": true,
    "deleted": false,
    "id": "abc",
    "processing": {
        "embedding": "queued",
        "prepare": "queued",
        "speech": "queued",
        "summary": "queued",
        "vision": "queued"
    },
    "status": "queued"
}

MediaIn#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

MediaOut#

Moderation#

OrderIn#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "items": [
        {
            "item": "sku-1",
            "price": 990,
            "quantity": 2
        },
        {
            "item": "sku-2",
            "price": 450
        },
        {
            "item": "sku-new",
            "properties": {
                "brand": "Дом"
            },
            "title": "Кружка керамическая"
        }
    ],
    "occurred_at": "2026-09-14T12:00:00Z",
    "order_id": "A-100500",
    "user": {
        "user_id": "u-42"
    }
}

OrderLineIn#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

OrderLineRejection#

OrderResponse#

Пример

{
    "accepted": 2,
    "order_id": "A-100500",
    "rejected": [
        {
            "code": "unknown_item",
            "index": 2,
            "item": "sku-x"
        }
    ]
}

OrdersBatchRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

OrdersBatchResponse#

Пример

{
    "results": [
        {
            "accepted": 3,
            "index": 0,
            "ok": true,
            "order_id": "A-1",
            "rejected": []
        },
        {
            "error": {
                "code": "validation_failed",
                "details": [
                    {
                        "code": "too_old",
                        "field": "occurred_at",
                        "message": "заказ старше 730 дней"
                    }
                ],
                "message": "Поля не прошли проверку"
            },
            "index": 1,
            "ok": false,
            "order_id": "A-2"
        }
    ]
}

OrdersBatchResult#

Processing#

ProfileBatchRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

ProfileBatchResponse#

Пример

{
    "results": [
        {
            "index": 0,
            "ok": true
        },
        {
            "error": {
                "code": "validation_failed",
                "details": [
                    {
                        "code": "pii_not_allowed",
                        "field": "attributes.email",
                        "message": "персональные данные не принимаются"
                    }
                ],
                "message": "Поля не прошли проверку"
            },
            "index": 1,
            "ok": false
        }
    ]
}

ProfileBatchResult#

ProfileRequest#

Переданные поля заменяются, null очищает поле, непереданные не меняются.

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "age": 29,
    "attributes": {
        "subscriptions": 3,
        "tier": "gold"
    },
    "city": "Казань",
    "followed_authors": [
        "channel-7"
    ],
    "gender": "female",
    "interests": [
        "горные велосипеды",
        "фотография"
    ],
    "user": {
        "user_id": "u-42"
    }
}

ProfileResponse#

Пример

{
    "identity": "user",
    "updated_fields": [
        "gender",
        "birth_year"
    ]
}

ReprocessRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "steps": [
        "summary",
        "embedding"
    ]
}

SearchChunkOut#

StoredProfile#

Пример

{
    "attributes": {
        "tier": "gold"
    },
    "birth_year": 1997,
    "city": "казань",
    "fields_updated_at": {
        "birth_year": "2026-09-14T12:00:00Z",
        "gender": "2026-09-14T12:00:00Z"
    },
    "followed_authors": [
        "channel-7"
    ],
    "gender": "female",
    "identity": "user",
    "interests": [
        "горные велосипеды"
    ],
    "personalization": true
}

SummaryOut#

TranscriptOut#

TranscriptSegment#

UserDeleteRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "user": {
        "user_id": "u-42"
    }
}

UserDeleteResponse#

Пример

{
    "deleted": true
}

UserLinkRequest#

Другие поля не принимаются: неизвестное поле — ошибка unknown_field.

Пример

{
    "anonymous_id": "b7f3c9",
    "fingerprint_uuid": "0b8f6a52-3f3e-4a57-9d51-6c1a1f0e7a01",
    "user_id": "u-42"
}

UserLinkResponse#

Пример

{
    "events_moved": 12,
    "merged": true
}