Skip to main content
GET
Obter um modelo do catálogo

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticar as requisições à API do Flowker. Provisionada por meio da variável de ambiente API_KEY durante o deployment.

Parâmetros de caminho

id
string
obrigatório

Identificador único do modelo do catálogo.

Resposta

Indica que a solicitação foi bem-sucedida e a resposta contém os dados solicitados.

category
string

Categoria do modelo.

Exemplo:

"payments"

description
string

Descrição do modelo.

Exemplo:

"Validate payment with balance check and risk analysis"

id
string

Identificador único do modelo.

Exemplo:

"payment-validation"

name
string

Nome de exibição do modelo.

Exemplo:

"Payment Validation"

paramSchema
string

JSON Schema que define os parâmetros esperados para este modelo. Dinamicamente enriquecido com as opções de configuração de provedores ativos quando aplicável.

Exemplo:

"{\"type\":\"object\",\"properties\":{\"midaz_config_id\":{\"type\":\"string\"}}}"

version
string

Versão do modelo.

Exemplo:

"1.0.0"