> ## 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.

# Create a Provider Configuration

> Use this endpoint to create a new provider configuration. The configuration is validated against the provider's JSON Schema.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml post /v1/provider-configurations
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/provider-configurations:
    post:
      tags:
        - Provider Configurations API
      summary: Create a Provider Configuration
      description: >-
        Use this endpoint to create a new provider configuration. The
        configuration is validated against the provider's JSON Schema.
      operationId: createProviderConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProviderConfigurationInput'
        description: Request body containing the provider configuration details.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigurationCreateOutput'
          description: >-
            Indicates that the resource was successfully created and the
            operation was completed as expected.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was malformed or contained invalid
            parameters.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indicates that the requested resource could not be found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request could not be completed due to a conflict
            with the current state of the resource.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was well-formed but contains semantic
            errors that prevent processing.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    CreateProviderConfigurationInput:
      properties:
        config:
          additionalProperties:
            type: object
          description: >-
            Provider-specific configuration that is validated against the
            provider's JSON Schema.
          example:
            baseUrl: https://api.clearsale.com.br
            apiKey: cs-key-abc123
            environment: production
          type: object
        description:
          description: Human-readable description of this provider configuration.
          example: ClearSale anti-fraud for Pix transactions
          maxLength: 500
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Custom key-value pairs for tagging.
          example:
            environment: production
            team: risk
          type: object
        name:
          description: Unique name for this provider configuration.
          example: ClearSale Production
          maxLength: 100
          minLength: 1
          type: string
        providerId:
          description: >-
            ID of the catalog provider to configure. Must match a registered
            provider.
          example: clearsale
          type: string
      required:
        - config
        - name
        - providerId
      type: object
    ProviderConfigurationCreateOutput:
      properties:
        createdAt:
          description: Timestamp when the configuration was created.
          example: '2026-03-17T14:00:00Z'
          format: date-time
          type: string
        id:
          description: Unique identifier of the created configuration.
          example: c3d4e5f6-a7b8-9012-cdef-345678901234
          format: uuid
          type: string
        name:
          description: Name of the configuration.
          example: ClearSale Production
          type: string
        status:
          description: Initial status (always `active` on creation).
          example: active
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````