Pular para o conteúdo principal
GET
/
v1
/
catalog
/
templates
/
{id}
Obter um modelo do catálogo
curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/catalog/templates/{id} \
  --header 'X-API-Key: <api-key>'
{
  "category": "payments",
  "description": "Validate payment with balance check and risk analysis",
  "id": "payment-validation",
  "name": "Payment Validation",
  "paramSchema": "{\"type\":\"object\",\"properties\":{\"midaz_config_id\":{\"type\":\"string\"}}}",
  "version": "1.0.0"
}

Autorizações

X-API-Key
string
header
obrigatório

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during 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"