Získejte seznam všech šablon
Koncový bod se používá k získání seznamu všech šablon systému včetně šablon Video, Carousel, Image, Quotes a Memes. Toto je stránkovaný koncový bod, a proto obdržíte stránkovanou odpověď.
Adresa URL požadavku
- GET https://brain.predis.ai/predis_api/v1/get_templates/
Parametry požadavku
| Jméno | Popis | Typ | Výchozí hodnota | Možné hodnoty | Požadovaný |
|---|---|---|---|---|---|
brand_id | Brand_id slouží jako jedinečný identifikátor vaší značky. Pomocí brand_id budete mít také přístup ke svým vlastním šablonám na první stránce. | Řetězec | None | YOUR_BRAND_ID | Ano |
media_type | Chcete-li získat šablony určitého typu média. | Řetězec | single_image | single_image, carousel, video | Ne |
post_type | Chcete-li získat šablony konkrétního typu příspěvku. Pro meme a quotes zveřejnit media_type by měla být single_image. | Řetězec | generic | generic, meme, quotes | Ne |
aspect_ratio | Chcete-li získat šablony s určitým poměrem stran. | Řetězec | all | square, portrait, landscape, all | Ne |
page_n | Chcete-li načíst šablony z dané stránky, uveďte číslo stránky. | Celé číslo | 1 | 1, 2, 3...etc | Ne |
items_n | Pro každou stránku uveďte požadovaný počet šablon. | Celé číslo | 10 | 1, 2, 3...etc | Ne |
Ukázka odpovědi na úspěch
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Ukázka odezvy na chybu
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Kódy odezvy
| Stavový kód HTTP | Chybový kód | Zpráva uživatele | Doporučené řešení |
|---|---|---|---|
| 429 | 001 | Byl dosažen maximální počet požadavků | Dosáhli jste maximálního počtu hodinových požadavků Byl jste omezen sazbou. Chvíli počkejte a zkuste to znovu |
| 400 | 002 | Neplatný brand_id pokud | Zadali jste neplatné brand_id. Uveďte prosím platný brand_id a zkuste to znovu. Přečtěte si více zde |
| 400 | 003 | Čísla stránek čísla položek jsou neplatná | Ujistěte se, že hodnota page_n a items_n je celé číslo |
| 400 | 004 | Pokud aspect_ratio není podporováno | Ujistěte se, že hodnota aspect_ratio pole je podporováno. Pro více podrobností zkontrolujte parametry požadavku ve výše uvedené tabulce |
| 400 | 005 | Poskytnutá hodnota pro media_type pole není platné | Ujistěte se, že hodnota je jedna z single_image, carousel or video |
| 400 | 006 | Poskytnutá hodnota pro video_duration pole není platné | Ujistěte se, že hodnota je buď short or long |
| 400 | 007 | Poskytnutá hodnota pro post_type pole není platné | Ujistěte se, že hodnota je buď generic, meme or quotes |
| 400 | 008 | Poskytnutá hodnota pro post_type pole není platné pro dané media_type | Poskytnuté post_type a media_type kombinace příspěvků zatím není podporována. Pro více podrobností zkontrolujte parametry požadavku ve výše uvedené tabulce |
Omezení rychlosti
Standard API pro tento koncový bod platí limity sazeb. Přečtěte si více o limitech sazeb zde