Stoplight Elements Integration API

Integration and embedding guides for using Elements in React, Angular, and plain HTML via Web Components or CDN.

Documentation GitHub OpenAPI

Operations 5

GET /open-source/elements Get Stoplight Elements Overview #

GET /docs/elements Stoplight Elements Get Elements Documentation #

GET /docs/elements/b074dc07b3bae-getting-started-with-elements-in-react Stoplight Elements Get React Integration Guide #

GET /docs/elements/19a7f9f0cbf23-getting-started-with-web-component Stoplight Elements Get Web Component Integration Guide #

GET /docs/elements/507fb7fab9b7d-getting-started-with-elements-in-angular Stoplight Elements Get Angular Integration Guide #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/elements-integration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Stoplight Elements Integration 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.
  version: 8.0.0
  contact:
    name: Stoplight Support
    url: https://stoplight.io/contact-us
  license:
    name: Apache 2.0
    url: https://github.com/stoplightio/elements/blob/main/LICENSE
servers:
- url: https://stoplight.io
  description: Stoplight Documentation and Marketing Site
tags:
- name: Integration
  description: Integration and embedding guides for using Elements in React, Angular, and plain HTML via Web Components or CDN.
paths:
  /open-source/elements:
    get:
      operationId: getElementsOverview
      summary: Get Stoplight Elements Overview
      description: Returns the Stoplight Elements open-source landing page describing the component library, its features, supported standards, and links to getting started guides and documentation.
      tags:
      - Integration
      responses:
        '200':
          description: Successful response returning the Elements overview page.
          content:
            text/html:
              schema:
                type: string
  /docs/elements:
    get:
      operationId: getElementsDocumentation
      summary: Stoplight Elements Get Elements Documentation
      description: Returns the main Elements documentation landing page with links to getting started guides for React, Web Components, and Angular, as well as the full configuration options reference.
      tags:
      - Integration
      responses:
        '200':
          description: Successful response returning the Elements documentation index.
          content:
            text/html:
              schema:
                type: string
  /docs/elements/b074dc07b3bae-getting-started-with-elements-in-react:
    get:
      operationId: getReactGettingStarted
      summary: Stoplight Elements Get React Integration Guide
      description: Returns the getting started guide for integrating Stoplight Elements as React components. Covers installation of @stoplight/elements, importing the API component, providing an apiDescriptionUrl or apiDescriptionDocument prop, choosing a layout, and configuring the router prop.
      tags:
      - Integration
      responses:
        '200':
          description: Successful response returning the React integration guide.
          content:
            text/html:
              schema:
                type: string
  /docs/elements/19a7f9f0cbf23-getting-started-with-web-component:
    get:
      operationId: getWebComponentGettingStarted
      summary: Stoplight Elements Get Web Component Integration Guide
      description: Returns the getting started guide for embedding Stoplight Elements as a Web Component (Custom Element) via CDN or npm. Covers including the web-components bundle, using the elements-api custom element tag in HTML, and setting attributes for apiDescriptionUrl, router, and layout.
      tags:
      - Integration
      responses:
        '200':
          description: Successful response returning the Web Component integration guide.
          content:
            text/html:
              schema:
                type: string
  /docs/elements/507fb7fab9b7d-getting-started-with-elements-in-angular:
    get:
      operationId: getAngularGettingStarted
      summary: Stoplight Elements Get Angular Integration Guide
      description: Returns the getting started guide for integrating Stoplight Elements into an Angular application, covering the CUSTOM_ELEMENTS_SCHEMA import, component registration, and attribute binding.
      tags:
      - Integration
      responses:
        '200':
          description: Successful response returning the Angular integration guide.
          content:
            text/html:
              schema:
                type: string
externalDocs:
  description: Stoplight Elements Documentation
  url: https://docs.stoplight.io/docs/elements

Stoplight Elements Integration API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources