Ottieni un elenco di tutti i modelli
L'endpoint viene utilizzato per ottenere un elenco di tutti i modelli di sistema inclusi i modelli Video, Carousel, Immagine, Citazioni e Meme. Questo è un endpoint impaginato e quindi riceverai una risposta impaginata.
URL richiesta
- GET https://brain.predis.ai/predis_api/v1/get_templates/
Richiedi parametri
| Nome | Descrizione | Tipo | Valore di default | Possibili valori | Obbligatorio |
|---|---|---|---|---|---|
brand_id | Il brand_id funge da identificatore univoco per il tuo marchio. Utilizzando brand_id, avrai anche accesso ai tuoi modelli personalizzati nella prima pagina. | Corda | None | YOUR_BRAND_ID | Si |
media_type | Per ottenere modelli di un tipo di supporto specifico. | Corda | single_image | single_image, carousel, video | Non |
post_type | Per ottenere modelli di una specifica tipologia di post. Per meme and quotes settimana media_type dovrebbe essere single_image. | Corda | generic | generic, meme, quotes | Non |
aspect_ratio | Per ottenere modelli con proporzioni specifiche. | Corda | all | square, portrait, landscape, all | Non |
page_n | Indicare il numero di pagina per recuperare i modelli da quella particolare pagina. | Numero intero | 1 | 1, 2, 3...etc | Non |
items_n | Indicare il numero desiderato di modelli per ogni pagina. | Numero intero | 10 | 1, 2, 3...etc | Non |
Esempio di risposta positiva
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Esempio di risposta all'errore
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Codici di risposta
| HTTP Status Code | Codice di errore | Messaggio utente | Soluzione consigliata |
|---|---|---|---|
| 429 | 001 | Numero massimo di richieste raggiunto | Numero massimo di richieste orarie raggiunto Hai ricevuto un limite di velocità. Attendi un po' e riprova |
| 400 | 002 | invalido brand_id purché | Hai fornito un invalido brand_id. Si prega di fornire un valido brand_id e riprovare. Per saperne di più Qui. |
| 400 | 003 | I numeri di pagina del numero di articoli non sono validi | Assicurati del valore di page_n and items_n è intero |
| 400 | 004 | Fornito aspect_ratio non è supportato | Assicurati del valore di aspect_ratio il campo è supportato. Per ulteriori dettagli, controlla i parametri della richiesta nella tabella sopra |
| 400 | 005 | Il valore fornito per il file media_type il campo non è valido | Assicurati che il valore sia uno di single_image, carousel or video |
| 400 | 006 | Il valore fornito per il file video_duration il campo non è valido | Assicurati che il valore sia uno dei due short or long |
| 400 | 007 | Il valore fornito per il file post_type il campo non è valido | Assicurati che il valore sia uno dei due generic, meme or quotes |
| 400 | 008 | Il valore fornito per il file post_type il campo non è valido per il dato media_type | Il fornito post_type and media_type la combinazione di post non è ancora supportata. Per ulteriori dettagli, controlla i parametri della richiesta nella tabella sopra |
rate limiting
Standard API i limiti di velocità si applicano a questo endpoint. Ulteriori informazioni sui limiti di tariffa Qui.