Публичный REST API

Доступность функции

Публичный REST API доступен на платных тарифах. Во время бесплатного пробного периода API недоступен. Чтобы воспользоваться возможностями API, необходимо перейти на соответствующий план.

Что такое публичный API Нейро42

С помощью REST API Нейро42 вы можете управлять системой программно — выполнять те же операции, что и в интерфейсе платформы, но через HTTP-запросы. Это удобно для автоматизации, интеграций и построения собственных инструментов поверх Нейро42.

В данном разделе вы узнаете:

как проходить аутентификацию в API;
как работать с пагинацией в запросах;
какие конечные точки доступны (endpoint reference).

Кроме того, в самой платформе есть специальный узел API Нейро42, который позволяет обращаться к API прямо из workflow.

Если вы впервые работаете с REST API

Документация предполагает, что вы знакомы с основами REST. Если нет — вот полезные материалы:

KnowledgeOwl: вводное руководство по работе с API — простые примеры запросов к REST API; https://support.knowledgeowl.com/help/work-with-apis
IBM Cloud Learn Hub: Что такое API? — высокоуровневое объяснение; https://www.ibm.com/think/topics/api
IBM Cloud Learn Hub: Что такое REST API? — более глубокое погружение в архитектуру REST; https://www.ibm.com/think/topics/rest-apis
MDN Web Docs: Обзор HTTP — описание протокола и методов, лежащих в основе REST. https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Overview

Эти материалы помогут быстрее ориентироваться в терминологии и формате взаимодействия.

Предупреждение о применении иностранного языка

Настоящий мануал включает иностранные термины и выражения, оставленные в оригинале ввиду специфики предметной области и сложности однозначного перевода на русский язык. Данные элементы используются исключительно в целях повышения точности и ясности изложенного материала, поскольку точные аналоги на русском языке либо отсутствуют, либо существенно усложняют восприятие информации пользователями-профессионалами.

Техническая документация не является информацией для широкого круга потребителей. Документация предназначена исключительно для специализированных целей и рассчитана на аудиторию профессионалов, обладающих соответствующей квалификацией и знанием отраслевых стандартов и терминологии. Использование иностранной лексики согласуется с положениями действующего российского законодательства, регулирующего употребление иностранных слов в специальных материалах, направленных на профессиональных пользователей

Данная мера принята для минимизации рисков неправильного толкования ключевых понятий и предотвращения негативных последствий, связанных с некорректностью переводов сложных технических терминов и выражений.

Мы обращаем внимание на тот факт, что наличие иностранного языка в данной документации обусловлено профессиональной необходимостью и соответствует установленным нормам и правилам использования специализированной литературы и документации в Российской Федерации.

Свяжитесь с нами

* нажимая на кнопку, Вы даете согласие на обработку персональных данных