Replicate
Visão geral
Seção intitulada “Visão geral”O Replicate é uma plataforma de IA em nuvem que permite executar modelos de aprendizado de máquina via API, sem necessidade de configurar ou gerenciar servidores e GPUs. Com a integração Replicate no SquadOS, seus agentes podem criar previsões com qualquer modelo público da plataforma, fazer fine-tuning de modelos, gerenciar deployments e arquivos, e orquestrar pipelines completos de IA generativa.
- Site oficial: https://replicate.com/
- Documentação na Composio: docs.composio.dev/toolkits/replicate
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Token de API gerado na sua conta Replicate, usado para autenticar todas as requisições. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse replicate.com e faça login (ou crie uma conta gratuita).
- Vá em Account settings → API tokens (ou acesse diretamente replicate.com/account/api-tokens).
- Clique em Create token, dê um nome ao token e confirme.
- Copie o token gerado — esse é o valor a usar no campo
api_keyao conectar no SquadOS.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Replicate. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa o token de API obtido acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Obter informações da conta
Seção intitulada “Obter informações da conta”REPLICATE_ACCOUNT_GET
Obtém as informações da conta autenticada. Use quando precisar recuperar detalhes sobre a conta associada ao token de API.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Cancelar previsão
Seção intitulada “Cancelar previsão”REPLICATE_CANCEL_PREDICTION
Cancela uma previsão que ainda está em execução. Use quando precisar interromper uma previsão em andamento para liberar recursos ou encerrar a execução.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
prediction_id | string | Sim | O ID da previsão a cancelar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter coleção de modelos
Seção intitulada “Obter coleção de modelos”REPLICATE_COLLECTIONS_GET
Obtém uma coleção específica de modelos pelo seu slug. Use quando precisar de informações detalhadas sobre uma coleção e seus modelos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
collection_slug | string | Sim | O identificador slug da coleção, ex.: super-resolution ou text-to-image. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar coleções de modelos
Seção intitulada “Listar coleções de modelos”REPLICATE_COLLECTIONS_LIST
Lista todas as coleções de modelos disponíveis. Use quando precisar recuperar as coleções disponíveis. As coleções são agrupamentos curados de modelos relacionados. A resposta inclui apenas metadados da coleção (nome, slug, descrição), não os modelos individuais de cada coleção; use REPLICATE_MODELS_GET para detalhes por modelo. A resposta pode incluir um campo next não nulo indicando páginas adicionais; siga-o para enumerar todas as coleções.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar modelo
Seção intitulada “Criar modelo”REPLICATE_CREATE_MODEL
Cria um novo modelo no Replicate com owner, nome, visibilidade e hardware especificados. Use quando precisar criar um modelo de destino antes de iniciar um treinamento LoRA/fine-tune.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome do modelo. Deve ser único entre todos os modelos do usuário ou organização. |
owner | string | Sim | O nome do usuário ou organização que será dono do modelo. Deve ser o mesmo que está fazendo a requisição. |
hardware | string | Sim | O SKU do hardware usado para executar o modelo. Os valores possíveis podem ser obtidos pelo endpoint hardware.list. |
paper_url | string | Não | URL para o artigo científico do modelo. |
github_url | string | Não | URL para o código-fonte do modelo no GitHub. |
visibility | string | Sim | Se o modelo deve ser público ou privado. Modelos públicos podem ser vistos e executados por qualquer pessoa; modelos privados são restritos ao owner. |
description | string | Não | Descrição do modelo. |
license_url | string | Não | URL para a licença do modelo. |
cover_image_url | string | Não | URL para a imagem de capa do modelo. Deve ser um arquivo de imagem. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar previsão para deployment
Seção intitulada “Criar previsão para deployment”REPLICATE_CREATE_PREDICTION
Cria uma previsão para um Deployment do Replicate. IMPORTANTE: esta ação funciona APENAS com Deployments do Replicate (instâncias persistentes que você cria e gerencia), NÃO com modelos públicos. Deployments são criados via REPLICATE_DEPLOYMENTS_CREATE. Para executar modelos públicos (ex.: meta/llama-2-70b-chat, stability-ai/sdxl), use REPLICATE_MODELS_PREDICTIONS_CREATE. Use wait_for para aguardar a conclusão da previsão.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
input | object | Sim | Objeto JSON com as entradas do modelo. As chaves e tipos devem corresponder exatamente ao schema do modelo do deployment; consulte REPLICATE_MODELS_README_GET ou REPLICATE_MODELS_EXAMPLES_LIST antes. Para entradas de arquivo, verifique os IDs de arquivo via REPLICATE_FILES_LIST antes de enviar. |
webhook | string | Não | URL HTTPS para receber callbacks de webhook. |
wait_for | integer | Não | Segundos a aguardar pela conclusão da previsão; adiciona o header Prefer: wait=<n> se fornecido. Intervalo válido: 1–60; se a previsão não concluir nesse período, use polling ou webhook. |
deployment_name | string | Sim | Nome do deployment. NOTA: este é o nome do deployment, NÃO o nome de um modelo público. Deployments são criados via REPLICATE_DEPLOYMENTS_CREATE. Para executar modelos públicos, use REPLICATE_MODELS_PREDICTIONS_CREATE. |
deployment_owner | string | Sim | Usuário ou organização que é dono do deployment. NOTA: apenas para Deployments do Replicate, NÃO para modelos públicos. Para modelos públicos, use REPLICATE_MODELS_PREDICTIONS_CREATE. |
webhook_events_filter | array | Não | Lista de eventos para acionar chamadas de webhook. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar deployment
Seção intitulada “Criar deployment”REPLICATE_DEPLOYMENTS_CREATE
Cria um novo deployment com modelo, versão, hardware e parâmetros de escalonamento especificados. Use quando precisar implantar um modelo para uso em produção com auto-scaling.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Identificador do deployment. |
model | string | Sim | Nome completo do modelo no formato owner/name. |
version | string | Sim | O ID de versão do modelo de 64 caracteres a implantar. |
hardware | string | Sim | SKU de hardware do endpoint hardware.list. |
max_instances | integer | Sim | Número máximo de instâncias para auto-scaling. |
min_instances | integer | Sim | Número mínimo de instâncias para auto-scaling. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir deployment
Seção intitulada “Excluir deployment”REPLICATE_DEPLOYMENTS_DELETE
Exclui um deployment da sua conta. Use quando precisar remover um deployment. Os deployments precisam estar offline e sem uso por pelo menos 15 minutos antes da exclusão.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
deployment_name | string | Sim | O nome do deployment a excluir. O deployment deve estar offline e sem uso por pelo menos 15 minutos antes da exclusão. |
deployment_owner | string | Sim | O usuário ou organização que é dono do deployment. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes do deployment
Seção intitulada “Obter detalhes do deployment”REPLICATE_DEPLOYMENTS_GET
Obtém os detalhes de um deployment pelo owner e nome. Use quando precisar de informações sobre um deployment específico, incluindo configuração de release e configurações de hardware.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
deployment_name | string | Sim | O nome do deployment. |
deployment_owner | string | Sim | O nome do usuário ou organização que é dono do deployment. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar deployments
Seção intitulada “Listar deployments”REPLICATE_DEPLOYMENTS_LIST
Lista todos os deployments associados à conta. Use quando precisar recuperar as configurações dos deployments e seus últimos releases.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar arquivo
Seção intitulada “Criar arquivo”REPLICATE_FILES_CREATE
Cria ou faz upload de um arquivo para o Replicate. Use quando precisar enviar conteúdo de arquivo com metadados opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
content | object | Sim | Arquivo a fazer upload. |
metadata | object | Não | Metadados fornecidos pelo usuário associados ao arquivo (deve ser JSON válido). |
content_type | string | Não | O tipo de conteúdo/MIME do arquivo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir arquivo
Seção intitulada “Excluir arquivo”REPLICATE_FILES_DELETE
Exclui um arquivo pelo seu ID. Use quando precisar remover um arquivo do armazenamento. Retorna 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file_id | string | Sim | O identificador único do arquivo a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes do arquivo
Seção intitulada “Obter detalhes do arquivo”REPLICATE_FILES_GET
Obtém os detalhes de um arquivo pelo seu ID. Use quando precisar inspecionar informações de um arquivo enviado antes de realizar operações. As URLs retornadas podem ter vida útil curta; baixe ou persista os arquivos necessários logo após a recuperação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file_id | string | Sim | O ID do arquivo a recuperar. Deve ter origem em um upload anterior ou em saída de previsão. Use REPLICATE_FILES_LIST para confirmar que o ID existe antes de chamar esta ação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar arquivos
Seção intitulada “Listar arquivos”REPLICATE_FILES_LIST
Recupera uma lista paginada de arquivos enviados. Use para visualizar todos os arquivos criados pelo usuário ou organização autenticada. Os arquivos são ordenados do mais recente para o mais antigo. A paginação é baseada em cursor: siga o cursor next até que esteja vazio para recuperar todos os arquivos. Limite as requisições a 1–2/segundo para evitar erros 429. Use para validar file_ids atuais antes de passá-los para ações de previsão, pois IDs desatualizados causam erros em tempo de execução.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter previsão
Seção intitulada “Obter previsão”REPLICATE_GET_PREDICTION
Obtém o status e a saída de uma previsão pelo seu ID. Use quando precisar verificar o andamento de uma previsão em execução ou recuperar os resultados de uma previsão concluída.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
prediction_id | string | Sim | O ID da previsão a obter. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar hardware disponível
Seção intitulada “Listar hardware disponível”REPLICATE_HARDWARE_LIST
Lista os SKUs de hardware disponíveis para modelos e deployments. Use quando precisar ver as opções de hardware disponíveis na plataforma Replicate.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar exemplos de modelo
Seção intitulada “Listar exemplos de modelo”REPLICATE_MODELS_EXAMPLES_LIST
Lista exemplos de previsões para um modelo específico. Use quando quiser recuperar exemplos ilustrativos fornecidos pelo autor após identificar o modelo. Os exemplos retornados são payloads mínimos funcionais; compare com REPLICATE_MODELS_README_GET antes de chamar REPLICATE_CREATE_PREDICTION para satisfazer a validação estrita de entradas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
model_name | string | Sim | O nome do modelo para o qual listar exemplos. Deve corresponder exatamente ao slug da URL do Replicate (sensível a maiúsculas). |
model_owner | string | Sim | O nome do usuário ou organização que é dono do modelo. Deve corresponder exatamente ao slug da URL do Replicate (sensível a maiúsculas). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes do modelo
Seção intitulada “Obter detalhes do modelo”REPLICATE_MODELS_GET
Obtém os detalhes de um modelo específico pelo owner e nome. Consulte o schema de entrada retornado antes de construir qualquer requisição de previsão — cada modelo define seus próprios campos obrigatórios/opcionais (ex.: prompt, aspect_ratio, version); chaves ausentes ou desconhecidas causam erros de validação. Schemas e versões disponíveis podem mudar; verifique novamente antes do uso em produção.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
model_name | string | Sim | O nome do modelo, ex.: hello-world. Deve ser um slug exato e sensível a maiúsculas do Replicate (minúsculas, hifenizado); ex.: use hello-world, não Hello World. |
model_owner | string | Sim | O usuário ou organização que é dono do modelo, ex.: replicate. Deve ser um slug exato e sensível a maiúsculas; ex.: use replicate, não Replicate. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar modelos públicos
Seção intitulada “Listar modelos públicos”REPLICATE_MODELS_LIST
Lista modelos públicos com paginação e ordenação. Use quando precisar navegar pelos modelos disponíveis ou encontrar modelos ordenados por data de criação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação para navegar pelos resultados. Use a URL next das respostas anteriores para buscar a próxima página. |
sort_by | string (model_created_at | latest_version_created_at) | Não | Campo pelo qual ordenar os modelos. As opções são model_created_at (quando o modelo foi criado) ou latest_version_created_at (quando a versão mais recente foi criada). O padrão é latest_version_created_at. |
sort_direction | string (asc | desc) | Não | Direção da ordenação — asc para ascendente ou desc para descendente. O padrão é desc (mais recente primeiro). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar previsão de modelo
Seção intitulada “Criar previsão de modelo”REPLICATE_MODELS_PREDICTIONS_CREATE
Cria uma previsão usando um modelo oficial do Replicate. Use quando precisar executar inferência com um modelo específico usando seu owner e nome. Suporta espera síncrona (até 60 segundos) e webhooks para notificações assíncronas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
input | object | Sim | Entradas do modelo como objeto JSON. O schema varia por modelo — cada modelo tem seu próprio conjunto de campos obrigatórios, parâmetros opcionais e restrições de validação (ex.: limites máximos de dimensão para modelos de imagem). IMPORTANTE: antes de fazer previsões, use REPLICATE_MODELS_GET para buscar o openapi_schema do modelo, que contém todos os parâmetros de entrada válidos e suas restrições. |
webhook | string | Não | URL HTTPS para receber requisições POST quando ocorrerem atualizações na previsão. |
wait_for | integer | Não | Segundos a aguardar pela conclusão da previsão (1–60); adiciona o header Prefer: wait=<n> para bloquear e aguardar de forma síncrona. |
model_name | string | Sim | O nome do modelo como aparece no Replicate. Deve ser correspondência exata. Encontre nomes válidos buscando em replicate.com ou usando as ações de busca/lista de modelos. O identificador completo do modelo é {model_owner}/{model_name}. |
model_owner | string | Sim | O usuário ou organização que é dono do modelo no Replicate. Encontre owners válidos buscando modelos em replicate.com ou usando as ações de busca/lista. Exemplos: meta, stability-ai, black-forest-labs, bytedance, google. |
cancel_after | string | Não | Duração máxima de execução com sufixos de unidade opcionais (s/m/h); mínimo de 5 segundos. Exemplo: 60s ou 5m. |
webhook_events_filter | array | Não | Filtra os gatilhos de webhook por tipo de evento: start, output, logs ou completed. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter README do modelo
Seção intitulada “Obter README do modelo”REPLICATE_MODELS_README_GET
Obtém o conteúdo do README de um modelo em formato Markdown. Consulte junto com REPLICATE_MODELS_EXAMPLES_LIST antes de chamar REPLICATE_CREATE_PREDICTION — o Replicate impõe schemas JSON estritos nas entradas dos modelos e retorna erros 422 para chaves ou tipos incorretos. Use após recuperar detalhes do modelo quando quiser ver sua documentação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
model_name | string | Sim | O nome do modelo, ex.: hello-world. |
model_owner | string | Sim | O usuário ou organização que é dono do modelo, ex.: replicate. Deve corresponder exatamente ao slug da URL do Replicate (sensível a maiúsculas). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter versão do modelo
Seção intitulada “Obter versão do modelo”REPLICATE_MODELS_VERSIONS_GET
Obtém uma versão específica de um modelo. Use quando precisar de detalhes sobre uma versão específica, incluindo seu schema e metadados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
model_name | string | Sim | O nome do modelo, ex.: hello-world. |
version_id | string | Sim | O identificador de 64 caracteres da versão. |
model_owner | string | Sim | O nome do usuário ou organização que é dono do modelo, ex.: replicate. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar versões do modelo
Seção intitulada “Listar versões do modelo”REPLICATE_MODELS_VERSIONS_LIST
Lista todas as versões de um modelo específico. Use quando precisar ver todas as versões disponíveis de um modelo, ordenadas da mais recente para a mais antiga.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
model_name | string | Sim | O nome do modelo, ex.: hello-world. |
model_owner | string | Sim | O usuário ou organização que é dono do modelo, ex.: replicate. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar previsão por versão
Seção intitulada “Criar previsão por versão”REPLICATE_PREDICTIONS_CREATE
Cria uma previsão para executar um modelo por ID de versão. Use quando tiver um identificador específico de versão de modelo e precisar executar inferência com as entradas fornecidas. Suporta espera síncrona e notificações via webhook.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
input | object | Sim | Entradas do modelo como objeto JSON. O schema varia por modelo. Arquivos devem ser URLs HTTP (para arquivos acima de 256 KB ou reutilizáveis) ou data URLs (para arquivos com até 256 KB). |
stream | boolean | Não | Descontinuado. A disponibilidade de streaming agora está incluída nas URLs da resposta. |
version | string | Sim | Identificador da versão do modelo. Aceita os formatos: {owner}/{name}, {owner}/{name}:{version_id} ou {version_id} isolado. |
webhook | string | Não | URL HTTPS para receber requisições POST quando ocorrerem atualizações na previsão. O corpo espelha a resposta de obter previsão. |
wait_for | integer | Não | Segundos (1–60) para manter a conexão aberta até o modelo finalizar. Adiciona o header Prefer: wait=<n>. |
cancel_after | string | Não | Tempo máximo de execução antes do cancelamento automático. Aceita durações com sufixos opcionais (s/m/h). Mínimo: 5 segundos. Exemplos: 30s, 5m, 1h30m45s. |
webhook_events_filter | array | Não | Controla os gatilhos do webhook. Opções: start, output, logs, completed. Eventos de output/logs são throttled a uma vez por 500 ms. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as previsões
Seção intitulada “Listar todas as previsões”REPLICATE_PREDICTIONS_LIST
Lista todas as previsões do usuário ou organização autenticada com paginação. Use quando precisar recuperar o histórico de previsões ou filtrar previsões por data de criação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
created_after | string | Não | Inclui apenas previsões criadas a partir desta data e hora, no formato ISO 8601 (ex.: 2024-01-01T00:00:00Z). Útil para filtrar previsões recentes. |
created_before | string | Não | Inclui apenas previsões criadas antes desta data e hora, no formato ISO 8601 (ex.: 2024-12-31T23:59:59Z). Útil para filtrar previsões mais antigas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar modelos e coleções
Seção intitulada “Buscar modelos e coleções”REPLICATE_SEARCH
Busca modelos, coleções e documentação usando consultas de texto (beta). Use quando precisar encontrar modelos ou coleções relevantes com base em palavras-chave ou descrições.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número máximo de resultados de modelos a retornar. Deve estar entre 1 e 50. O padrão é 20. |
query | string | Sim | A string de consulta de busca a executar. Pode buscar em modelos, coleções e documentação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Cancelar treinamento
Seção intitulada “Cancelar treinamento”REPLICATE_TRAININGS_CANCEL
Cancela uma operação de treinamento em andamento no Replicate. Use quando precisar interromper um job de treinamento que está em progresso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
training_id | string | Sim | O identificador da operação de treinamento a ser encerrada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar job de treinamento
Seção intitulada “Criar job de treinamento”REPLICATE_TRAININGS_CREATE
Cria um job de treinamento para uma versão específica de modelo. Use quando precisar fazer fine-tuning de um modelo com dados de treinamento customizados. Suporta notificações via webhook para atualizações de status do treinamento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do modelo a treinar. |
input | object | Sim | Objeto JSON com as entradas para a função train() do modelo Cog. O schema varia por modelo. |
owner | string | Sim | Nome do usuário ou organização que é dono do modelo. |
webhook | string | Não | URL HTTPS para receber requisições POST quando ocorrerem atualizações no treinamento. |
version_id | string | Sim | O identificador de versão do modelo de 64 caracteres a usar no treinamento. |
destination | string | Sim | Modelo de destino para onde fazer push, no formato {owner}/{name}. |
webhook_events_filter | array | Não | Lista de tipos de evento que acionam chamadas de webhook. Opções: start, output, logs, completed. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar jobs de treinamento
Seção intitulada “Listar jobs de treinamento”REPLICATE_TRAININGS_LIST
Lista todos os jobs de treinamento do usuário ou organização autenticada com paginação. Use quando precisar recuperar o histórico de treinamentos ou verificar o status dos jobs.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cursor | string | Não | Cursor de paginação. Use o cursor do campo next da resposta anterior. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar metadados do modelo
Seção intitulada “Atualizar metadados do modelo”REPLICATE_UPDATE_MODELS
Atualiza os metadados de um modelo, incluindo descrição, URLs e README. Use quando precisar modificar a visibilidade de um modelo, sua documentação ou links associados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
readme | string | Não | O conteúdo do README do modelo. |
paper_url | string | Não | URL para o artigo científico do modelo. |
github_url | string | Não | URL para o código-fonte do modelo no GitHub. |
model_name | string | Sim | O nome do modelo a atualizar. |
description | string | Não | Descrição do modelo. |
license_url | string | Não | URL para a licença do modelo. |
model_owner | string | Sim | O nome do usuário ou organização que é dono do modelo. |
weights_url | string | Não | URL para os pesos do modelo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter segredo de assinatura do webhook
Seção intitulada “Obter segredo de assinatura do webhook”REPLICATE_WEBHOOKS_SECRET_GET
Obtém o segredo de assinatura do webhook padrão. Use quando precisar recuperar a chave secreta usada para verificar a autenticidade dos webhooks.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |