API для создания реалистичных фотографий в Facee
Методы API
1. Начать тренировку
Метод:
POST /training/start
Заголовки:
— apiToken (обязательно)
Данные запроса (multipart/form-data):
— clientName
(string, опционально) - Имя пользователя.
— clientAge
(number, опционально) - Возраст пользователя.
— clientGender
("male" | "female", опционально) - Пол пользователя.
— clientPhotos
(File[], обязательно, как минимум 15 файлов) - Фотографии пользователя.
Response (JSON):
— trainingID
(string) - Уникальный идентификатор тренировки.
Пример запроса:
POST /training/start
Content-Type: multipart/form-data
{
"clientName": "Иван",
"clientAge": 25,
"clientGender": "male",
"clientPhotos": [file1, file2, ...]
}
2. Проверить статус тренировки
Метод:
POST /training/status/
Заголовки:
— apiToken (обязательно)
Данные запроса (JSON):
— trainingID
(string, обязательно) - ID тренировки.
Ответ (JSON):
— status
(string) - Статус тренировки.
— trainingID
(string) - ID тренировки.
Пример запроса:
POST /training/status/
Content-Type: application/json
{
"trainingID": "abc123"
}
3. Сгенерировать результат (синхронно)
Метод:
POST /result/generate/sync
Заголовки:
— apiToken (обязательно)
Данные запроса (JSON):
— trainingID
(string, обязательно) - ID тренировки, на основе которой нужно сгенерировать результат.
— prompt
(string, обязательно, если не указан imageURI) - Текстовое описание желаемого результата.
— imageURI
(string, обязательно, если не указан prompt) - URI изображения, на основе которого нужно сгенерировать результат.
— style
(string, опционально) - Стиль генерируемого результата.
— numberOfResults
(number, опционально) - Количество результатов, которые нужно сгенерировать (по умолчанию 1). Максимум 4.
Ответ (JSON):
— items
(Array<{ resultURL: string, resultID: string }>) - Массив результатов.
Пример запроса:
POST /result/generate/sync
Content-Type: application/json
{
"trainingID": "abc123",
"prompt": "Она стоит на берегу океана",
"style": "polaroid",
"numberOfResults": 2
}
или
{
"trainingID": "abc123",
"imageURI": "https://example.com/image.jpg",
"style": "polaroid",
"numberOfResults": 1
}
Аутентификация
Все методы требуют токен API для аутентификации. Получите токен, обратившись к нам по адресу facee.ru.help@gmail.com
Обработка ошибок
Все ответы будут следовать стандартному формату ошибки, если возникнет проблема:
{
"code": "error_code",
"message": "Дополнительная информация об ошибке"
}
Подключение
Чтобы подключиться к нашему API, обратитесь к нам по адресу facee.ru.help@gmail.com