Вземете списък с всички шаблони
Крайната точка се използва за получаване на списък с всички системни шаблони, включително шаблони за видео, въртележка, изображение, цитати и мемове. Това е пагинирана крайна точка и следователно ще получите пагиниран отговор.
URL адрес на заявкаâ € <
- GET https://brain.predis.ai/predis_api/v1/get_templates/
Параметри на заявкатаâ € <
| Име | Описание | Тип | Стойност по подразбиране | Възможни стойности | Длъжен |
|---|---|---|---|---|---|
brand_id | Brand_id служи като уникален идентификатор за вашата марка. Използвайки brand_id, вие също ще имате достъп до персонализираните си шаблони на първата страница. | Низ | None | YOUR_BRAND_ID | Да |
media_type | За получаване на шаблони от определен тип медия. | Низ | single_image | single_image, carousel, video | Не |
post_type | За получаване на шаблони за определен тип публикация. За meme намлява quotes пускат media_type трябва да бъде single_image. | Низ | generic | generic, meme, quotes | Не |
aspect_ratio | За получаване на шаблони със специфично съотношение на страните. | Низ | all | square, portrait, landscape, all | Не |
page_n | Посочете номера на страницата, за да извлечете шаблони от тази конкретна страница. | цяло число | 1 | 1, 2, 3...etc | Не |
items_n | Посочете желания брой шаблони за всяка страница. | цяло число | 10 | 1, 2, 3...etc | Не |
Примерен успешен отговорâ € <
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Примерен отговор за грешкаâ € <
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Кодове за отговорâ € <
| HTTP код на състоянието | Код на грешка | Потребителско съобщение | Препоръчително решение |
|---|---|---|---|
| 429 | 001 | Достигнат е максималният брой заявки | Достигнат максимален брой заявки на час Вие сте били ограничени по скорост. Изчакайте известно време и опитайте отново |
| 400 | 002 | Невалиден brand_id осигурен | Предоставили сте невалиден brand_id. Моля, предоставете валиден brand_id и опитайте отново. Прочетете повече тук |
| 400 | 003 | Номерата на страниците на номера на елементите са невалидни | Уверете се, че стойността на page_n намлява items_n е цяло число |
| 400 | 004 | осигурен aspect_ratio не се поддържа | Уверете се, че стойността на aspect_ratio полето се поддържа. Моля, проверете параметрите на заявката в горната таблица за повече подробности |
| 400 | 005 | Предоставената стойност за media_type полето не е валидно | Уверете се, че стойността е една от single_image, carousel or video |
| 400 | 006 | Предоставената стойност за video_duration полето не е валидно | Уверете се, че стойността е едно от двете short or long |
| 400 | 007 | Предоставената стойност за post_type полето не е валидно | Уверете се, че стойността е едно от двете generic, meme or quotes |
| 400 | 008 | Предоставената стойност за post_type полето не е валидно за даденото media_type | Предоставеното post_type намлява media_type комбинация от публикации все още не се поддържа. Моля, проверете параметрите на заявката в горната таблица за повече подробности |
ограничаване на скоросттаâ € <
Standard API за тази крайна точка се прилагат ограничения на скоростта. Прочетете повече за лимитите на скоростта тук