Uzyskaj listę wszystkich szablonów
Punkt końcowy służy do uzyskania listy wszystkich szablonów systemu, w tym szablonów wideo, karuzeli, obrazów, cytatów i memów. To jest punkt końcowy podzielony na strony i dlatego otrzymasz odpowiedź podzieloną na strony.
Poproś o adres URLâ € <
- GET https://brain.predis.ai/predis_api/v1/get_templates/
Parametry żądaniaâ € <
| Imię i nazwisko | OPIS | Typ | Domyślna wartość | Możliwa wartość | Wymagane |
|---|---|---|---|---|---|
brand_id | Brand_id służy jako unikalny identyfikator Twojej marki. Używając brand_id, będziesz miał również dostęp do własnych szablonów na pierwszej stronie. | sznur | None | YOUR_BRAND_ID | Tak |
media_type | Aby uzyskać szablony określonego typu mediów. | sznur | single_image | single_image, carousel, video | Nie |
post_type | Aby uzyskać szablony określonego typu postu. Dla meme oraz quotes pisać media_type powinno być single_image. | sznur | generic | generic, meme, quotes | Nie |
aspect_ratio | Aby uzyskać szablony o określonych proporcjach. | sznur | all | square, portrait, landscape, all | Nie |
page_n | Wskaż numer strony, aby pobrać szablony z tej konkretnej strony. | Liczba całkowita | 1 | 1, 2, 3...etc | Nie |
items_n | Wskaż żądaną liczbę szablonów dla każdej strony. | Liczba całkowita | 10 | 1, 2, 3...etc | Nie |
Przykładowa odpowiedź zawierająca sukcesâ € <
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Przykładowa odpowiedź na błądâ € <
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Kody odpowiedziâ € <
| HTTP Status Code | Kod błędu | Wiadomość użytkownika | Zalecane rozwiązanie |
|---|---|---|---|
| 429 | 001 | Osiągnięto maksymalną liczbę żądań | Osiągnięto maksymalną liczbę żądań godzinowych Zostałeś ograniczony. Poczekaj chwilę i spróbuj ponownie |
| 400 | 002 | Nieważny brand_id pod warunkiem, | Podałeś nieprawidłowy brand_id. Proszę podać ważny brand_id i spróbuj ponownie. Przeczytaj więcej w tym miejscu |
| 400 | 003 | Numery stron numeru pozycji są nieprawidłowe | Upewnij się, że wartość page_n oraz items_n jest liczbą całkowitą |
| 400 | 004 | Opatrzony aspect_ratio nie jest wspierany | Upewnij się, że wartość aspect_ratio pole jest obsługiwane. Aby uzyskać więcej informacji, sprawdź parametry żądania w powyższej tabeli |
| 400 | 005 | Podana wartość dla media_type pole jest nieprawidłowe | Upewnij się, że wartość jest jedną z single_image, carousel or video |
| 400 | 006 | Podana wartość dla video_duration pole jest nieprawidłowe | Upewnij się, że wartość wynosi albo short or long |
| 400 | 007 | Podana wartość dla post_type pole jest nieprawidłowe | Upewnij się, że wartość wynosi albo generic, meme or quotes |
| 400 | 008 | Podana wartość dla post_type pole nie jest prawidłowe dla podanego media_type | Dostarczone post_type oraz media_type kombinacja postów nie jest jeszcze obsługiwana. Aby uzyskać więcej informacji, sprawdź parametry żądania w powyższej tabeli |
Ograniczanie tempaâ € <
Standardowa API limity szybkości mają zastosowanie do tego punktu końcowego. Przeczytaj więcej o limitach stawek w tym miejscu