> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter um modelo do catálogo

> Utilize este endpoint para recuperar os metadados e o JSON Schema de parâmetros de um modelo específico do catálogo. Se o modelo referencia configurações de provedores, o schema é dinamicamente enriquecido com as opções de configuração de provedores ativos.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml get /v1/catalog/templates/{id}
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/catalog/templates/{id}:
    get:
      tags:
        - Catalog API
      summary: Obter um modelo do catálogo
      description: >-
        Utilize este endpoint para recuperar os metadados e o JSON Schema de
        parâmetros de um modelo específico do catálogo. Se o modelo referencia
        configurações de provedores, o schema é dinamicamente enriquecido com as
        opções de configuração de provedores ativos.
      operationId: getCatalogTemplate
      parameters:
        - description: Identificador único do modelo do catálogo.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogTemplateDetail'
          description: >-
            Indica que a solicitação foi bem-sucedida e a resposta contém os
            dados solicitados.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Indica que o recurso solicitado não foi encontrado.
components:
  schemas:
    CatalogTemplateDetail:
      properties:
        category:
          description: Categoria do modelo.
          example: payments
          type: string
        description:
          description: Descrição do modelo.
          example: Validate payment with balance check and risk analysis
          type: string
        id:
          description: Identificador único do modelo.
          example: payment-validation
          type: string
        name:
          description: Nome de exibição do modelo.
          example: Payment Validation
          type: string
        paramSchema:
          description: >-
            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.
          example: '{"type":"object","properties":{"midaz_config_id":{"type":"string"}}}'
          type: string
        version:
          description: Versão do modelo.
          example: 1.0.0
          type: string
      type: object
    CommonResponse:
      properties:
        code:
          description: Código de erro legível por máquina.
          example: FLK-0200
          type: string
        entityType:
          description: Tipo de entidade relacionada ao erro.
          example: executor
          type: string
        err:
          description: Detalhes adicionais do erro quando disponíveis.
          type: object
        message:
          description: Mensagem de erro legível por humanos.
          example: Executor with ID 'nonexistent' not found in catalog
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Not Found
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````