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

# Get the flow config schema

> The JSON Schema of the `config` every flow endpoint takes and returns: inputs, every node type (enrichment, waterfall, condition with if/else or ordered rules, jq, merge, math, table lookup, table add/upsert row, exporter, Output step) and `output_fields`. Generated from the model the server validates against, so it is exact for shape and types. Cross-node rules (refs resolve, no cycles, enrichment params exist and required ones are bound) are not expressible in JSON Schema; `POST /v1/flows/validate-config` checks those.

> [!NOTE]
>
> The exact shape of a flow `config`, generated from the model the server validates against. Read it before you build a config by hand: it lists every node type, including **Output steps** (`type: "output"` with the top-level `output_fields` they fill), **multi-way conditions** (`rules` + `otherwise_nodes` instead of `formula` / `then_nodes` / `else_nodes`), and the `table_add_row`, `table_upsert_row` and `exporter` destinations. Rules that span nodes are checked by [Validate a flow config](https://docs.databar.ai/api-reference/endpoint/flows-validate-config.md).


## OpenAPI

````yaml GET /v1/flows/config-schema
openapi: 3.1.0
info:
  title: Databar.ai API
  description: >-

    # Authentication


    Databar uses API keys to allow access to the API. You can find your API key
    in your workspace home page, but to use the REST API you’ll first need to
    schedule a call with us.

    Our API expects the API key to be included in all API requests to the server
    in the Header of your request with the key `x-apikey`.

    To find your API key, head over to your Databar workspace and click
    Integrations.


    **Example:**


    `bash

    curl https://api.databar.ai/v1/user/me -H x-apikey: {YOUR_API_KEY}`
  contact:
    email: info@databar.ai
  version: 0.1.2
servers:
  - url: https://api.databar.ai
    description: Production
security: []
paths:
  /v1/flows/config-schema:
    get:
      tags:
        - Flows
      summary: JSON Schema of a flow config
      description: >-
        The JSON Schema of the `config` every flow endpoint takes and returns:
        inputs, every node type (enrichment, waterfall, condition with if/else
        or ordered rules, jq, merge, math, table lookup, table add/upsert row,
        exporter, Output step) and `output_fields`. Generated from the model the
        server validates against, so it is exact for shape and types. Cross-node
        rules (refs resolve, no cycles, enrichment params exist and required
        ones are bound) are not expressible in JSON Schema; `POST
        /v1/flows/validate-config` checks those.
      operationId: get_flow_config_schema_v1_flows_config_schema_get
      parameters:
        - name: x-apikey
          in: header
          required: true
          schema:
            type: string
            title: API Key
            description: API Key for authentication
          description: API Key for authentication
      responses:
        '200':
          description: JSON Schema (draft 2020-12) of a flow config
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
        '403':
          description: Forbidden

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.