Scalar · Example Payload

Scalar Api Reference Config Example

API ClientAPI DocumentationAPI ReferencesCode GenerationDeveloper ToolsOpenAPIRegistrySDKSwagger

Scalar Api Reference Config Example is an example object payload from Scalar, with 1 top-level field. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

example

Example Payload

Raw ↑ 
{
  "example": {
    "title": "Scalar API Reference Configuration",
    "description": "Example of embedding Scalar API References in an HTML page or framework.",
    "type": "code",
    "language": "html",
    "code": "<!doctype html>\n<html>\n  <head>\n    <title>Payments API Reference</title>\n    <meta charset=\"utf-8\" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n  </head>\n  <body>\n    <script\n      id=\"api-reference\"\n      data-url=\"https://registry.scalar.com/my-org/payments-api\"\n      data-configuration='{\n        \"theme\": \"purple\",\n        \"darkMode\": true,\n        \"hiddenClients\": [\"unirest\"],\n        \"defaultHttpClient\": {\n          \"targetKey\": \"javascript\",\n          \"clientKey\": \"fetch\"\n        }\n      }'\n    ></script>\n    <script src=\"https://cdn.jsdelivr.net/npm/@scalar/api-reference\"></script>\n  </body>\n</html>",
    "notes": [
      "Set data-url to your OpenAPI spec URL or Scalar Registry URL",
      "Supported themes: default, alternate, moon, purple, solarized, bluePlanet, deepSpace, saturn, kepler, mars",
      "See https://guides.scalar.com/scalar/scalar-api-references/getting-started for full configuration options"
    ]
  }
}

Work with this as data

Every example 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 examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • 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 example 
curl "https://apis.io/api/v1/examples/scalar-api-reference-config-example"
All examples 
curl "https://apis.io/api/v1/examples?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.