Skip to main content
GET
/
client
/
project
/
{project_id}
/
item-sets
cURL
curl --request GET \
  --url https://api.spellit.ai/api/client/project/{project_id}/item-sets \
  --header 'API-Access-Key: <api-key>'
{
  "item_sets": [
    {
      "id": 123,
      "name": "item_set_name_abc123",
      "created_at": "2024-01-15T10:30:00Z",
      "status": "processed",
      "status_within_project": "processed"
    }
  ],
  "total_count": 1
}
Возвращает список всех item_set для указанного проекта.

Параметры

  • project_id (int, path, обязательный) - ID проекта
  • page (int, query, опциональный) - Номер страницы для пагинации
  • per_page (int, query, опциональный) - Количество элементов на странице
  • status_filter (string, query, опциональный) - Фильтр по статусу item_set

Примеры запросов

Пример 1: Базовый запрос

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets" \
  -H "API-Access-Key: your access key"

Пример 2: С пагинацией

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets?page=2&per_page=10" \
  -H "API-Access-Key: your access key"

Пример 3: С фильтром по статусу

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets?status_filter=processed" \
  -H "API-Access-Key: your access key"

Возможные ошибки

  • 401 Unauthorized - Отсутствует или неверный токен аутентификации
  • 403 Forbidden - Проект не принадлежит текущему пользователю
  • 404 Not Found - Проект с указанным ID не найден
  • 500 Internal Server Error - Внутренняя ошибка сервера

Описание полей ответа

  • item_sets - массив объектов item_set
    • id - уникальный идентификатор item_set
    • name - название item_set (содержит UUID для уникальности)
    • created_at - дата и время создания (ISO 8601)
    • status - статус обработки item_set (added, processing, processed, processing_failed)
    • status_within_project - статус item_set в рамках проекта (added, all_items_processed, processing, processed, processing_failed)
  • total_count - общее количество найденных item_set

Статусы и их значения

Статусы item_set:

  • added - добавлен, ожидает обработки
  • processing - в процессе обработки
  • processed - успешно обработан
  • processing_failed - ошибка обработки

Статусы item_set в рамках проекта:

  • added - добавлен в проект
  • all_items_processed - все элементы обработаны
  • processing - в процессе обработки
  • processed - полностью обработан
  • processing_failed - ошибка обработки

Дополнительные примеры использования

Примеры обработки ошибок:

Ошибка аутентификации:

# Запрос без токена
curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets"

# Ответ:
# HTTP/1.1 401 Unauthorized
{
  "detail": "Not authenticated"
}

Ошибка доступа к проекту:

# Запрос к проекту, к которому нет доступа
curl -X GET "https://api.spellit.ai/api/client/project/999/item-sets" \
  -H "API-Access-Key: your access key"

# Ответ:
# HTTP/1.1 403 Forbidden
{
  "detail": "Project not found or access denied"
}

Authorizations

API-Access-Key
string
header
required

API-ключ для доступа к эндпоинтам

Path Parameters

project_id
integer
required

ID проекта

Query Parameters

page
integer
default:1

Номер страницы для пагинации

per_page
integer
default:10

Количество элементов на странице

status_filter
enum<string>

Фильтр по статусу item_set

Available options:
added,
processing,
processed,
processing_failed

Response

Успешный ответ

item_sets
object[]
total_count
integer

Общее количество найденных item_set