Stoplight Elements API

naftiko: 1.0.0-alpha2
info:
  label: Stoplight Elements API
  description: Stoplight Elements is an open-source API documentation component library that renders OpenAPI 2.0, 3.0, and
    3.1 specifications as beautiful, interactive developer documentation. This OpenAPI specification represents the conceptual
    API surface of the Stoplight Elements component library, including its React component props, Web Component attributes,
    configuration options, and supported layouts. Elements is a client-side component library and does not expose a traditional
    REST API. It is configured via React props on the API React component or HTML attributes on the elements-api custom element.
  tags:
  - Elements
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: elements
    baseUri: https://stoplight.io
    description: Stoplight Elements API HTTP API.
    resources:
    - name: open-source-elements
      path: /open-source/elements
      operations:
      - name: getelementsoverview
        method: GET
        description: Get Stoplight Elements Overview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: docs-elements
      path: /docs/elements
      operations:
      - name: getelementsdocumentation
        method: GET
        description: Stoplight Elements Get Elements Documentation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: docs-elements-b074dc07b3bae-getting-started-with
      path: /docs/elements/b074dc07b3bae-getting-started-with-elements-in-react
      operations:
      - name: getreactgettingstarted
        method: GET
        description: Stoplight Elements Get React Integration Guide
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: docs-elements-19a7f9f0cbf23-getting-started-with
      path: /docs/elements/19a7f9f0cbf23-getting-started-with-web-component
      operations:
      - name: getwebcomponentgettingstarted
        method: GET
        description: Stoplight Elements Get Web Component Integration Guide
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: docs-elements-507fb7fab9b7d-getting-started-with
      path: /docs/elements/507fb7fab9b7d-getting-started-with-elements-in-angular
      operations:
      - name: getangulargettingstarted
        method: GET
        description: Stoplight Elements Get Angular Integration Guide
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: docs-elements-zg9jojmynju5mtm-elements-configura
      path: /docs/elements/ZG9jOjMyNjU5MTM-elements-configuration-options
      operations:
      - name: getconfigurationoptions
        method: GET
        description: Stoplight Elements Get Configuration Options Reference
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: elements-rest
    description: REST adapter for Stoplight Elements API.
    resources:
    - path: /open-source/elements
      name: getelementsoverview
      operations:
      - method: GET
        name: getelementsoverview
        description: Get Stoplight Elements Overview
        call: elements.getelementsoverview
        outputParameters:
        - type: object
          mapping: $.
    - path: /docs/elements
      name: getelementsdocumentation
      operations:
      - method: GET
        name: getelementsdocumentation
        description: Stoplight Elements Get Elements Documentation
        call: elements.getelementsdocumentation
        outputParameters:
        - type: object
          mapping: $.
    - path: /docs/elements/b074dc07b3bae-getting-started-with-elements-in-react
      name: getreactgettingstarted
      operations:
      - method: GET
        name: getreactgettingstarted
        description: Stoplight Elements Get React Integration Guide
        call: elements.getreactgettingstarted
        outputParameters:
        - type: object
          mapping: $.
    - path: /docs/elements/19a7f9f0cbf23-getting-started-with-web-component
      name: getwebcomponentgettingstarted
      operations:
      - method: GET
        name: getwebcomponentgettingstarted
        description: Stoplight Elements Get Web Component Integration Guide
        call: elements.getwebcomponentgettingstarted
        outputParameters:
        - type: object
          mapping: $.
    - path: /docs/elements/507fb7fab9b7d-getting-started-with-elements-in-angular
      name: getangulargettingstarted
      operations:
      - method: GET
        name: getangulargettingstarted
        description: Stoplight Elements Get Angular Integration Guide
        call: elements.getangulargettingstarted
        outputParameters:
        - type: object
          mapping: $.
    - path: /docs/elements/ZG9jOjMyNjU5MTM-elements-configuration-options
      name: getconfigurationoptions
      operations:
      - method: GET
        name: getconfigurationoptions
        description: Stoplight Elements Get Configuration Options Reference
        call: elements.getconfigurationoptions
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: elements-mcp
    transport: http
    description: MCP adapter for Stoplight Elements API for AI agent use.
    tools:
    - name: getelementsoverview
      description: Get Stoplight Elements Overview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getelementsoverview
      outputParameters:
      - type: object
        mapping: $.
    - name: getelementsdocumentation
      description: Stoplight Elements Get Elements Documentation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getelementsdocumentation
      outputParameters:
      - type: object
        mapping: $.
    - name: getreactgettingstarted
      description: Stoplight Elements Get React Integration Guide
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getreactgettingstarted
      outputParameters:
      - type: object
        mapping: $.
    - name: getwebcomponentgettingstarted
      description: Stoplight Elements Get Web Component Integration Guide
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getwebcomponentgettingstarted
      outputParameters:
      - type: object
        mapping: $.
    - name: getangulargettingstarted
      description: Stoplight Elements Get Angular Integration Guide
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getangulargettingstarted
      outputParameters:
      - type: object
        mapping: $.
    - name: getconfigurationoptions
      description: Stoplight Elements Get Configuration Options Reference
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: elements.getconfigurationoptions
      outputParameters:
      - type: object
        mapping: $.