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

# Run a capability or endpoint



## OpenAPI

````yaml /api-reference/openapi-v2.yaml post /api/v2/run
openapi: 3.0.3
info:
  title: DumplingAI Unified API
  version: 2.0.0
  description: >
    Transport reference for DumplingAI's Unified API under `/api/v2`.

    These endpoints cover search, details, execution, usage, and balance for
    capabilities, providers, and endpoints.
servers:
  - url: https://app.dumplingai.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
    description: Search and inspect capabilities and provider endpoints.
  - name: Execution
    description: Execute capabilities and provider endpoints.
  - name: Usage
    description: Inspect balance, usage, and transactions for a specific API key.
paths:
  /api/v2/run:
    post:
      tags:
        - Execution
      summary: Run a capability or endpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunRequest'
      responses:
        '200':
          description: Capability result
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Policy rejected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Unknown capability or endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RunRequest:
      type: object
      properties:
        type:
          type: string
          enum:
            - capability
            - endpoint
        id:
          type: string
          description: >-
            Capability id like `search_news` or `extract_document`, or endpoint
            id like `firecrawl.scrape`.
        provider:
          type: string
          description: >-
            Optional provider override for capability runs only when that
            capability supports provider selection. For example, `screenshot`
            supports `firecrawl`, `scrapingfish`, and `phantomjscloud`, while
            DumplingAI-managed capabilities such as `extract_document` use
            `dumplingai`.
        input:
          type: object
          additionalProperties: true
        options:
          type: object
          properties:
            include_native:
              type: boolean
          additionalProperties: false
      required:
        - type
        - id
        - input
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        requestId:
          type: string
        error:
          type: string
        code:
          type: string
      required:
        - success
        - requestId
        - error
        - code
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````