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

# Execute Connector

> Execute external API



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/runtime/v1/connectors/{connector}
openapi: 3.0.0
info:
  title: Runflow Runtime API
  description: >-
    Programmatic surface for the Runflow platform — used by the SDK, the CLI,
    the execution engine, and any server-to-server caller. Authenticate with an
    `x-api-key` header (or `Authorization: Bearer ...`).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.runflow.ai
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags: []
paths:
  /api/v1/runtime/v1/connectors/{connector}:
    post:
      tags:
        - Runtime API - Connectors
      summary: Execute Connector
      description: Execute external API
      operationId: RuntimeConnectorController_executeConnector
      parameters:
        - name: connector
          required: true
          in: path
          description: Connector slug or name
          schema:
            type: string
        - name: environment
          required: false
          in: query
          description: staging | production. Falls back to instance default.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorExecuteDto'
      responses:
        '201':
          description: >-
            Connector response envelope: { success, data, metadata: { connector,
            resource, ... } } when successful. On error returns { success:
            false, error, fallback?: true }.
        '401':
          description: Missing or invalid API key.
        '404':
          description: Connector slug not found or no instance configured.
      security:
        - bearer: []
components:
  schemas:
    ConnectorExecuteDto:
      type: object
      properties:
        resource:
          type: string
          description: Resource slug
          example: get-users
        action:
          type: string
          description: Action to perform (deprecated, optional)
          example: get
        data:
          type: object
          description: Request data - can be flat or structured format
          example:
            path:
              id: '123'
            query:
              limit: 10
            body:
              name: John
            headers:
              X-Custom: value
        options:
          type: object
          description: Execution options (mock, timeout, credentials, etc)
          example:
            useMock: false
            timeout: 5000
      required:
        - resource

````