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

# Get the API index

> Returns the public, unauthenticated index of the API: the base URL,
supported authentication methods and OAuth scopes, the rate-limit and
deprecation conventions, and links to the documentation and this
specification. Use it to discover the current surface without a
credential.




## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v1
openapi: 3.1.0
info:
  title: Fluent API
  version: 1.0.0
  summary: Run Fluent agents and access connected data.
  description: |
    The public Fluent API powers the CLI and customer integrations.
    Most successful responses wrap their payload in a data property. Errors
    contain detail and status properties without that envelope.
servers:
  - url: https://www.fluenterp.com
    description: Production
security:
  - ApiKey: []
  - BearerCredential: []
tags:
  - name: Discovery
    description: Find the API, its scopes, and its policies without a credential.
  - name: Agents
    description: Discover agents and prepare their input files.
  - name: Runs
    description: Start and monitor asynchronous agent runs.
  - name: Documents
    description: Read, process, and delete documents produced by agents.
  - name: Connections
    description: Discover connected systems and read their records.
  - name: Databases
    description: Discover queryable databases and schemas.
  - name: Tables
    description: Read records from a queryable table.
  - name: Queries
    description: Run queries against accessible databases.
  - name: Utilities
    description: Search the web and manage conversation resources.
  - name: MCP
    x-group: Model Context Protocol
    description: Connect an external MCP client to an agent's tools.
paths:
  /api/v1:
    get:
      tags:
        - Discovery
      summary: Get the API index
      description: |
        Returns the public, unauthenticated index of the API: the base URL,
        supported authentication methods and OAuth scopes, the rate-limit and
        deprecation conventions, and links to the documentation and this
        specification. Use it to discover the current surface without a
        credential.
      operationId: getApiIndex
      responses:
        '200':
          description: API index
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiIndex'
      security: []
components:
  schemas:
    ApiIndex:
      type: object
      description: |
        The public index of the API, served without a credential at /api/v1.
      additionalProperties: false
      required:
        - name
        - version
        - base_url
        - documentation_url
        - openapi_url
        - authentication
        - rate_limits
        - versioning
        - resources
      properties:
        name:
          type: string
          description: Human-readable API name.
        description:
          type: string
          description: What the API does.
        version:
          type: string
          description: Current major version, matching the URL path segment.
        base_url:
          type: string
          format: uri
          description: Absolute base URL every operation hangs off.
        documentation_url:
          type: string
          format: uri
        openapi_url:
          type: string
          format: uri
          description: This specification.
        developers_url:
          type: string
          format: uri
        llms_txt_url:
          type: string
          format: uri
        authentication:
          type: object
          additionalProperties: false
          required:
            - methods
          properties:
            methods:
              type: array
              description: Every credential type the API accepts.
              items:
                type: object
                additionalProperties: false
                required:
                  - type
                  - documentation_url
                properties:
                  type:
                    type: string
                    enum:
                      - api_key
                      - oauth2
                  headers:
                    type: array
                    description: Accepted header forms, for api_key.
                    items:
                      type: string
                  self_serve:
                    type: boolean
                    description: Whether a caller can issue this credential themselves.
                  flow:
                    type: string
                    description: OAuth flow, for oauth2.
                  metadata_url:
                    type: string
                    format: uri
                    description: RFC 8414 authorization-server metadata, for oauth2.
                  scopes_supported:
                    type: array
                    items:
                      type: string
                  documentation_url:
                    type: string
                    format: uri
        rate_limits:
          type: object
          additionalProperties: false
          required:
            - requests
            - window_seconds
            - response_headers
          properties:
            requests:
              type: integer
              description: Requests allowed per window.
            window_seconds:
              type: integer
            scope:
              type: string
              description: What the limit is counted against.
            response_headers:
              type: array
              items:
                type: string
            documentation_url:
              type: string
              format: uri
        versioning:
          type: object
          additionalProperties: false
          required:
            - strategy
            - current_version
          properties:
            strategy:
              type: string
              enum:
                - url_path
            current_version:
              type: string
            deprecation_headers:
              type: array
              items:
                type: string
            minimum_sunset_notice_days:
              type: integer
              description: Days between a Deprecation header appearing and its Sunset date.
            documentation_url:
              type: string
              format: uri
        resources:
          type: object
          description: Absolute URL per top-level resource, path templates included.
          additionalProperties:
            type: string
        clients:
          type: object
          additionalProperties: false
          properties:
            cli:
              type: string
              format: uri
              description: Package registry page for the official CLI.
            cli_documentation_url:
              type: string
              format: uri
        webhooks_documentation_url:
          type: string
          format: uri
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: A Fluent API key beginning with fl-.
    BearerCredential:
      type: http
      scheme: bearer
      bearerFormat: Fluent API key or OAuth access token
      description: |
        A Fluent API key beginning with fl-, or an OAuth access token beginning
        with flpt_ on operations that support OAuth.

````