Erhalten Sie eine Liste aller Vorlagen

Der Endpunkt wird verwendet, um eine Liste aller Systemvorlagen abzurufen, einschließlich Video-, Karussell-, Bild-, Zitat- und Meme-Vorlagen. Dies ist ein paginierter Endpunkt und daher erhalten Sie eine paginierte Antwort.

URL anfragen

• STARTE https://brain.predis.ai/predis_api/v1/get_templates/

Anforderungsparameter

Name	Beschreibung	Typ	Standardwert	Mögliche Werte	Erforderlich
brand_id	Die Brand_ID dient als eindeutige Kennung für Ihre Marke. Mit der Brand_ID haben Sie auf der ersten Seite auch Zugriff auf Ihre benutzerdefinierten Vorlagen.	Schnur	None	YOUR_BRAND_ID	Ja
media_type	Um Vorlagen eines bestimmten Medientyps zu erhalten.	Schnur	single_image	single_image, carousel, video	Nein
post_type	Um Vorlagen für einen bestimmten Beitragstyp zu erhalten. Für meme , quotes Beitrag media_type sollte sein single_image.	Schnur	generic	generic, meme, quotes	Nein
aspect_ratio	Um Vorlagen mit einem bestimmten Seitenverhältnis zu erhalten.	Schnur	all	square, portrait, landscape, all	Nein
page_n	Geben Sie die Seitenzahl an, um Vorlagen von dieser bestimmten Seite abzurufen.	ganze Zahl	1	1, 2, 3...etc	Nein
items_n	Geben Sie für jede Seite die gewünschte Anzahl Vorlagen an.	ganze Zahl	10	1, 2, 3...etc	Nein

Beispiel für eine erfolgreiche Antwort

{
    "templates": [{
        "template_id": "...",
        "media_type": "..."
    }],
    "total_pages": 50,
    "errors": []
}

Beispiel für eine Fehlerantwort

{
    "errors": [{
            "detail": "...",
            "solution": "..."
        }]
}

Antwortcodes

HTTP-Status-Code	Fehlercode	Benutzernachricht	Empfohlene Lösung
429	001	Maximale Anzahl an Anfragen erreicht	Maximale Anzahl stündlicher Anfragen erreicht. Ihre Rate wurde begrenzt. Warten Sie eine Weile und versuchen Sie es erneut.
400	002	Ungültig brand_id vorausgesetzt	Sie haben eine ungültige brand_id. Bitte geben Sie einen gültigen brand_id und versuchen Sie es erneut. Mehr erfahren werden auf dieser Seite erläutert
400	003	Seitenzahlen der Artikelnummer sind ungültig	Stellen Sie sicher, dass der Wert von page_n , items_n ist eine Ganzzahl
400	004	Vorausgesetzt aspect_ratio wird nicht unterstützt,	Stellen Sie sicher, dass der Wert von aspect_ratio Feld wird unterstützt. Weitere Einzelheiten finden Sie in den Anforderungsparametern in der obigen Tabelle.
400	005	Der angegebene Wert für die media_type Feld ist ungültig	Stellen Sie sicher, dass der Wert einer der folgenden ist: single_image, carousel or video
400	006	Der angegebene Wert für die video_duration Feld ist ungültig	Stellen Sie sicher, dass der Wert entweder short or long
400	007	Der angegebene Wert für die post_type Feld ist ungültig	Stellen Sie sicher, dass der Wert entweder generic, meme or quotes
400	008	Der angegebene Wert für die post_type Das Feld ist für das angegebene media_type	Die bereitgestellten post_type , media_type Kombination von Posts wird noch nicht unterstützt. Weitere Einzelheiten finden Sie in den Anforderungsparametern in der obigen Tabelle.

Rate Limiting

Standard API Ratenbegrenzungen gelten für dieses Endgerät. Lesen Sie mehr über die Ratenbegrenzungen werden auf dieser Seite erläutert