Obtenha uma lista de todos os modelos
O endpoint é usado para obter uma lista de todos os modelos do sistema, incluindo modelos de vídeo, carrossel, imagem, cotações e memes. Este é um endpoint paginado e, portanto, você receberá uma resposta paginada.
URL de solicitação
- ENTRE https://brain.predis.ai/predis_api/v1/get_templates/
Solicitar Parâmetros
| Nome | Descrição | Formato | Valor padrão | Valores Possíveis | Exigido |
|---|---|---|---|---|---|
brand_id | O brand_id serve como identificador exclusivo da sua marca. Usando o brand_id, você também terá acesso aos seus modelos personalizados na primeira página. | Tanga | None | YOUR_BRAND_ID | Sim |
media_type | Para obter modelos de um tipo de mídia específico. | Tanga | single_image | single_image, carousel, video | Não |
post_type | Para obter modelos de um tipo específico de postagem. Para meme e no quotes postar media_type deveria estar single_image. | Tanga | generic | generic, meme, quotes | Não |
aspect_ratio | Para obter modelos de uma proporção específica. | Tanga | all | square, portrait, landscape, all | Não |
page_n | Indique o número da página para recuperar modelos dessa página específica. | Número inteiro | 1 | 1, 2, 3...etc | Não |
items_n | Indique o número desejado de modelos para cada página. | Número inteiro | 10 | 1, 2, 3...etc | Não |
Exemplo de resposta de sucesso
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Exemplo de resposta de erro
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Códigos de Resposta
| Código de status HTTP | Erro de código | Mensagem do usuário | Solução recomendada |
|---|---|---|---|
| 429 | 001 | Número máximo de solicitações atingido | Número máximo de solicitações por hora atingido Você foi limitado pela taxa. Aguarde um pouco e tente novamente |
| 400 | 002 | Inválido brand_id fornecido | Você forneceu um inválido brand_id. Forneça um documento válido brand_id e tente novamente. Leia mais aqui. |
| 400 | 003 | Os números de página do número de itens são inválidos | Certifique-se de que o valor de page_n e no items_n é inteiro |
| 400 | 004 | Fornecido aspect_ratio não é suportado | Certifique-se de que o valor de aspect_ratio campo é suportado. Verifique os parâmetros de solicitação na tabela acima para obter mais detalhes |
| 400 | 005 | O valor fornecido para o media_type campo não é válido | Certifique-se de que o valor seja um dos single_image, carousel or video |
| 400 | 006 | O valor fornecido para o video_duration campo não é válido | Certifique-se de que o valor seja short or long |
| 400 | 007 | O valor fornecido para o post_type campo não é válido | Certifique-se de que o valor seja generic, meme or quotes |
| 400 | 008 | O valor fornecido para o post_type campo não é válido para o dado media_type | O fornecido post_type e no media_type combinação de postagem ainda não é suportada. Verifique os parâmetros de solicitação na tabela acima para obter mais detalhes |
Limitação de taxa
Padrão API limites de taxa se aplicam a este ponto final. Leia mais sobre os limites de taxa aqui.