Ontvang een lijst met alle sjablonen
Het eindpunt wordt gebruikt om een lijst te krijgen van alle systeemsjablonen, inclusief sjablonen voor video, carrousel, afbeeldingen, citaten en memes. Dit is een gepagineerd eindpunt en daarom ontvangt u een gepagineerd antwoord.
URL aanvragen
- Begin https://brain.predis.ai/predis_api/v1/get_templates/
Verzoek om parameters
| Naam | Beschrijving | Type | Standaardwaarde | Mogelijke waarden | Nodig |
|---|---|---|---|---|---|
brand_id | De brand_id dient als de unieke identificatie voor uw merk. Met behulp van de brand_id heeft u ook toegang tot uw aangepaste sjablonen op de eerste pagina. | Draad | None | YOUR_BRAND_ID | Ja |
media_type | Om sjablonen van een specifiek mediatype te verkrijgen. | Draad | single_image | single_image, carousel, video | Nee |
post_type | Om sjablonen van een specifiek type bericht te verkrijgen. Voor meme en quotes post media_type moet single_image. | Draad | generic | generic, meme, quotes | Nee |
aspect_ratio | Om sjablonen met een specifieke beeldverhouding te verkrijgen. | Draad | all | square, portrait, landscape, all | Nee |
page_n | Geef het paginanummer op om sjablonen van die specifieke pagina op te halen. | Geheel getal | 1 | 1, 2, 3...etc | Nee |
items_n | Geef per pagina het gewenste aantal sjablonen aan. | Geheel getal | 10 | 1, 2, 3...etc | Nee |
Voorbeeld van een succesreactie
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Voorbeeldfoutreactie
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Reactiecodes
| HTTP-statuscode | Error Code | Gebruikersbericht: | Aanbevolen oplossing |
|---|---|---|---|
| 429 | 001 | Maximaal aantal verzoeken bereikt | Maximaal aantal verzoeken per uur bereikt U bent beperkt in snelheid. Wacht even en probeer het opnieuw. |
| 400 | 002 | Ongeldig brand_id inbegrepen | U heeft een ongeldige opgegeven brand_id. Geef een geldig brand_id en probeer het opnieuw. Lees meer hier |
| 400 | 003 | Paginanummers van artikelnummer zijn ongeldig | Zorg ervoor dat de waarde van page_n en items_n is geheel getal |
| 400 | 004 | mits aspect_ratio wordt niet ondersteund | Zorg ervoor dat de waarde van aspect_ratio veld wordt ondersteund. Controleer de aanvraagparameters in de bovenstaande tabel voor meer details |
| 400 | 005 | De opgegeven waarde voor de media_type veld is niet geldig | Zorg ervoor dat de waarde een van is single_image, carousel or video |
| 400 | 006 | De opgegeven waarde voor de video_duration veld is niet geldig | Zorg ervoor dat de waarde een van beide is short or long |
| 400 | 007 | De opgegeven waarde voor de post_type veld is niet geldig | Zorg ervoor dat de waarde een van beide is generic, meme or quotes |
| 400 | 008 | De opgegeven waarde voor de post_type veld is niet geldig voor het gegeven media_type | de verstrekte post_type en media_type combinatie van berichten wordt nog niet ondersteund. Controleer de aanvraagparameters in de bovenstaande tabel voor meer details |
snelheidsbeperking
Standaard API snelheidslimieten zijn van toepassing op dit eindpunt. Lees meer over de tarieflimieten hier