Перейти к основному содержимому

Xenia AI API

Здравствуйте!

Мы рады предоставить вам доступ к Xenia AI API. С помощью этого API вы сможете создавать и обновлять вакансии (шаг «детали»: метаданные, условия и вопросы интервью), генерировать вакансию и вопросы по описанию, настраивать вопросы о компании и сопроводительное письмо, создавать интервью для кандидатов, получать список вакансий, просматривать кандидатов и забирать подробные результаты прохождения интервью, сопроводительного письма и аналитического кейса.

Базовый адрес​

Базовый адрес API:

https://api.xeniaai.com/openapi/v1

API-ключ выдаётся в кабинете. Подробнее — на странице Авторизация.

Общие правила​

  • Формат запросов и ответов: JSON.
  • Даты передаются в формате ISO 8601, например 2026-04-25T10:30:00Z.
  • Базовый адрес API уже включает путь /openapi/v1.
  • Для списков используется пагинация limit и offset.
  • limit автоматически ограничивается диапазоном от 10 до 200.
  • offset не может быть меньше 0.
  • По умолчанию списки возвращаются от новых записей к старым.

Коды ответов​

КодЗначение
200 OKЗапрос выполнен успешно.
400 Bad RequestВ запросе некорректные параметры, например неверный диапазон дат или оценка вне диапазона 0-10.
401 UnauthorizedНе передан или неверно указан API-ключ.
403 ForbiddenНет активной подписки или исчерпан лимит собеседований.
404 Not FoundЗапрошенная вакансия или интервью не найдены.

Справочник методов​

МетодURLНазначение
POST/interviewСоздать интервью для кандидата и получить ссылку на прохождение.
POST/positionsПолучить список вакансий.
GET/positions/{id}Получить подробную информацию по вакансии.
POST/positionСоздать вакансию (детали: метаданные, условия и вопросы интервью; опционально автогенерация вопросов).
POST/position/generateСоздать вакансию по текстовому описанию (title, topic, seniority и вопросы генерируются).
PUT/positions/{id}Обновить вакансию (детали: метаданные, условия и вопросы интервью).
PUT/positions/{id}/company-questionsЗаменить или очистить вопросы о компании.
PUT/positions/{id}/cover-letterВключить, обновить или отключить сопроводительное письмо.
POST/interviewsПолучить список интервью и кандидатов.
GET/interviews/{id}Получить подробные результаты конкретного интервью.