Вызвать сценарий через программный интерфейс

Перед началом

  • Проверьте. Доступ сценария имеет состояние Открыт, а выданный ключ действует. Получите публичный базовый адрес у службы поддержки организации.

  • Подготовьте. <PUBLIC_API_BASE>, путь из поля Эндпоинт, ключ <SCENARIO_KEY>, показанный арендатор <TENANT_ID>, безопасное поле input и уникальное непустое значение заголовка Idempotency-Key для одного логического запуска.

Выполните

  1. Подставьте значения в запрос:

curl -X POST "<PUBLIC_API_BASE><RUN_ENDPOINT>?wait=true" \
  -H "Authorization: Bearer <SCENARIO_KEY>" \
  -H "X-SmartMLOps-Tenant-Id: <TENANT_ID>" \
  -H "Idempotency-Key: <IDEMPOTENCY_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"input":"синтетический тестовый запрос","variables":{}}'
  1. Выполните запрос из разрешенного клиентского контура и дождитесь ответа. Синхронное ожидание ограничено 30 секундами.

Проверьте результат

Откройте сценарий и блок Обращения за 7 дней. Число прогонов должно увеличиться, а таблица - показать запуск с непустым идентификатором и успешным состоянием.

Без ?wait=true сервер возвращает код ответа 202, поле run_id и заголовок Location. Состояние читается запросом GET по адресу из Location с тем же ключом и заголовком арендатора. Для повтора того же логического запуска сохраняйте прежний Idempotency-Key.

Если не получилось

  • 400 invalid_request или 401 unauthorized. Для 400 проверьте заголовок арендатора, идентификатор сценария и JSON. Для 401 проверьте формат Authorization.

  • 403 forbidden или 404 not_found. Для 403 используйте ключ этого сценария. Ответ 404 не подтверждает существование чужого объекта.

  • 409 not_published или 422 model_unavailable. Откройте доступ и подготовьте модельный ключ либо выберите доступную модель.

  • 429 rate_limited. Дождитесь времени из Retry-After и повторите запрос с прежним Idempotency-Key.

  • 502 gateway_error, 503 key_service_unavailable или 503 gateway_unavailable. Сохраните время, идентификатор обращения и запуска. Для 502 передайте сведения роли portal-admin, для 503 - роли system-admin.

Завершите работу

Удалите временную копию ключа и тело тестового запроса из истории клиента по правилам организации. Ключ оставьте в разрешенном хранилище до окончания интеграции.