Scalar is an open-source API platform built around the OpenAPI standard. It provides API documentation (API References), an offline-first API client, a centralized API registry for managing OpenAPI documents, JSON schemas and Spectral rules, and automated SDK generation for TypeScript, Python, Go, PHP, Java, and Ruby. Used by teams at SmartBear, Microsoft ASP.NET, and 30+ framework ecosystems including Express, FastAPI, NestJS, and Spring Boot. The platform has 14.9k GitHub stars and is MIT licensed. Scalar is backed by a strong open-source community and positions itself as the modern, open alternative to Swagger UI and Postman.
Scalar publishes 2 API contracts indexed on the APIs.io network: Access Groups API, Analytics API, and API Docs API. Tagged areas include API Client, API Documentation, API Reference, Code Generation, and Developer Tools.
The Scalar catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 3 Spectral governance rulesets.
Scalar’s developer surface includes CLI, changelog, getting-started guide, API reference, authentication, documentation, pricing, and 47 more developer resources.
68.5/100exemplar▼ -8.1Agent55/100agent readyFront door AI4/6
moderate
Heartbeat100/100
alive
open core · MIT
Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →
AccessFreemiumSelf serve⚡ Free to try
2 published contracts3 Not an API1 MCP Servers3 Agent Skills
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/scalar/"><img src="https://apis.io/badge/scalar/card.svg" alt="Scalar on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card+8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Pagination+5 pts — share of collection GETs (an array, or one wrapped in data/items/results ...) that declare a page/limit/offset/cursor parameter, a Link header or a next/cursor field; na with no collection GETs
Protected Resource Metadata+5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified)
Agentic Commerce Well-Known Document+5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's
Consent & Bot Identity+3 pts — common[].type includes AIPREF, ContentSignal, WebBotAuth, or HTTPMessageSignatures
Kin Score — facets with the most composite points still available (weight × headroom):
Scalar is an area vendor: providers adopt it to run part of their developer surface. This is the Kin Score checks its features can move for a provider that adopts it, what each one really earns, and what it earns nothing for.
documentationcapability map10 features checked 2026-09-25 · rubric v0.22.0
Scalar’s documentation side earns the reference, try-it and llms.txt credit a provider would expect, and its adjacent products reach points a docs-only vendor cannot: generated SDKs and a CLI target (sdk_count_1, sdk_count_3, cli_present once published and declared) and public Spectral rules in the Registry (rules_present). The qualifier is agent readiness: both MCP servers are platform-graded (the docs MCP is one template; the installation MCP that calls the API is hosted at mcp.scalar.com, not the provider’s domain), the SKILL.md shipped with an SDK is generated, and custom domains and hosted MCP need the paid Pro plan.
Agent Readiness6.0 of 139 pts
Contract Governance10.0 of 33 pts
Developer Ergonomics20.8 of 42 pts
Discoverability4.0 of 54 pts
Check
Earns
Through
MCP Serverplatform Agent ReadinessCalls the provider’s API, but from mcp.scalar.com on one Scalar template; 0.22.0 grades that platform (0.25 of 12). The docs MCP on the provider’s domain is also a single template.
Request/Response Examplespartial Agent ReadinessThe dimension reads examples inside the OpenAPI first; code samples the reference renders reach only the Examples / Code Samples link fallback.
Publishes a ruleset Contract GovernanceMake the rule public in the Registry (or publish it elsewhere) and point apis.json at it; private rules publish nothing.
Documentationsaturated Developer Ergonomics95% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.
Publishes llms.txt DiscoverabilityGenerated from the provider’s own docs on the provider’s domain, so it reads as the provider’s (rule 2’s own-content, own-domain case).
API referencesaturated Developer Ergonomics94% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.
Across 8977 providers that publish a contract, adopting Scalar would move 8976. Median lift: composite +10.0 (90th percentile +12.4), agent readiness +3.1 (+4.3). Conditional rows excluded.
What Scalar ships that earns nothing (3)
Scalar API client (open source) — A Postman-compatible client is not a Postman collection the provider publishes.
Scalar Docs hosted site — No Scalar page claims an api-catalog, security.txt or protected-resource document on docs sites.
Scalar Registry — A contract hosted at registry.scalar.com sits on Scalar’s host, not one the provider controls.
A model, not a score. Adopting this vendor changes a provider's Kin Score only when the provider publishes the resulting artifacts on its own surface; nothing here writes a score, and no sponsorship or partnership can. The rating is not for sale → · Full vendor facets artifact
Markets this provider is in provisional
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
Individual APIs this provider publishes. MODELED: a real API behind a partner or contract gate; there is no public reference, so API Evangelist drew its shape. NOT AN API: a product area with no API behind it, not counted.
Scalar API References renders modern, interactive API documentation from OpenAPI and Swagger specifications. Features include multiple themes, custom styling, dark mode, mobile ...
Scalar API Client is a fully open-source, offline-first REST API client built on the OpenAPI standard. Supports collections, environments, pre/post-response scripting, test resu...
Scalar Docs enables teams to create and publish developer documentation that stays in sync with their API and code. Supports writing with a WYSIWYG editor, pulling Markdown and ...
Scalar Registry provides centralized management and versioning of OpenAPI Documents, JSON Schemas, and Spectral Rules with deep Git integration. Serves as the single source of t...
Scalar SDKs generates type-safe client libraries from OpenAPI specifications. Supported languages include TypeScript, Python, Golang, PHP, Java, and Ruby. Features include autom...
The Scalar CLI is a command-line interface for managing OpenAPI files, generating documentation, running mock servers, validating specs, and publishing to the Scalar Registry. E...
Open-source (MIT) renderer that turns an OpenAPI/Swagger or AsyncAPI document into an interactive API reference with a built-in request-testing panel and multi-language code sam...
Hosted developer-portal product that combines Markdown/MDX guides with generated API references, custom domains and subdomains, themes, versions, and two-way Git Sync from GitHu...
Hosted SDK generation that produces type-safe client libraries from an OpenAPI document for TypeScript, Python, Go, Java, PHP, C#, and Ruby, kept in sync with the registry. Paid...
AI layer that lets developers chat with an API inside the docs and exposes hosted MCP (Model Context Protocol) servers generated from an OpenAPI document so agents can call the ...
aid: scalar
name: Scalar
description: Scalar is an open-source API platform built around the OpenAPI standard. It provides API documentation (API References),
an offline-first API client, a centralized API registry for managing OpenAPI documents, JSON schemas and Spectral rules,
and automated SDK generation for TypeScript, Python, Go, PHP, Java, and Ruby. Used by teams at SmartBear, Microsoft ASP.NET,
and 30+ framework ecosystems including Express, FastAPI, NestJS, and Spring Boot. The platform has 14.9k GitHub stars and
is MIT licensed. Scalar is backed by a strong open-source community and positions itself as the modern, open alternative
to Swagger UI and Postman.
deliveryModel:
model: open-core
license: MIT
license_evidence:
repo: scalar/scalar
spdx: MIT
stars: 16190
open_source: true
commercial: true
callable_host: false
label: Open core · an OSS project plus a commercial hosted product
confidence: medium
source:
- openapi
- pricing
- repository-license
generated: '2026-09-25'
method: derived
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
gated: none
gated_source:
- onboarding
label: Freemium · Self-serve signup
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-06'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/scalar.png
url: https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/apis.yml
x-docs-platform: scalar
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-04
tags:
- API Client
- API Documentation
- API Reference
- Code Generation
- Developer Tools
- OpenAPI
- Registry
- SDK
- Swagger
tags_raw:
- API Client
- API Documentation
- API References
- Code Generation
- Developer Tools
- OpenAPI
- Registry
- SDKs
- Swagger
type: Index
access: 3rd-Party
position: Consuming
created: '2025-01-08'
modified: '2026-05-02'
specificationVersion: '0.23'
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
url: https://apievangelist.com
- aid: scalar:scalar-core
name: Scalar Core API
description: Core services for Scalar as defined in the OpenAPI spec.
humanURL: https://scalar.com
baseURL: https://api.scalar.com/core
properties: null
common:
- type: Spectral
url: rules/scalar-scalar-spectral-rules.yml
- type: IntegrationEdges
url: integrations/scalar-integration-edges.yml
- type: CapabilityMap
url: capabilities/scalar-capability-edges.yml
name: Scalar Business Capability Map
- type: Packages
url: packages/scalar-packages.yml
- type: FinOps
url: finops/scalar-finops.yml
- type: RateLimits
url: rate-limits/scalar-rate-limits.yml
- type: Plans
url: plans/scalar-plans-pricing.yml
- type: Spectral
url: rules/scalar-rules.yml
- type: Spectral
url: rules/scalar-jsonschema-spectral-rules.yml
- type: JSONLD
url: json-ld/scalar-context.jsonld
- type: Vocabulary
url: vocabulary/scalar-vocabulary.yml
- type: AgentSkill
url: skills/_index.yml
- type: Webhooks
url: asyncapi/scalar-webhooks.yml
- type: DataModel
url: data-model/scalar-data-model.yml
- type: CLI
url: cli/scalar-cli.yml
- type: ChangeLog
url: changelog/scalar-changelog.yml
- type: Conventions
url: conventions/scalar-conventions.yml
- type: Compliance
url: https://scalar.com/security
- type: ErrorCatalog
url: errors/scalar-problem-types.yml
- type: Conformance
url: conformance/scalar-conformance.yml
- type: LLMsTxt
url: llms/scalar-llms.txt
- type: MCPServer
url: mcp/scalar-mcp.yml
- type: SecurityTxt
url: well-known/scalar-dashboard-security.txt
- type: WellKnown
url: well-known/scalar-well-known.yml
- type: Hosts
url: hosts/scalar-hosts.yml
- type: Vendors
url: vendors/scalar-vendors.yml
- type: TermsOfService
url: https://scalar.com/legal/terms-and-conditions
- type: StatusPage
url: https://scalar.com/tools/api/tag/scalar-docs/get/v1/docs/slug/domain/status
- type: Security
url: https://scalar.com/security
- type: SDKs
url: https://scalar.com/sdk
- type: PrivacyPolicy
url: https://scalar.com/legal/privacy-policy
- type: Leadership
url: https://scalar.com/tools/api/models/team
- type: DeveloperPortal
url: https://scalar.com/solutions/developer-portal
- type: GettingStarted
url: https://scalar.com/products/docs/getting-started/index
- type: APIReference
url: https://scalar.com/llms.txt
- type: VendorFacets
url: vendor-facets/scalar-vendor-facets.yml
- type: AgenticAccess
url: agentic-access/scalar-agentic-access.yml
- type: TrustCenter
url: security/scalar-trust-center.yml
- type: VulnerabilityDisclosure
url: security/scalar-vulnerability-disclosure.yml
- type: DomainSecurity
url: security/scalar-domain-security.yml
- type: Authentication
url: authentication/scalar-authentication.yml
- type: LinkedIn
url: https://www.linkedin.com/company/scalar
- type: Website
url: https://scalar.com/
name: Scalar Website
- type: Documentation
url: https://guides.scalar.com/scalar/introduction
name: Scalar Documentation
- type: Pricing
url: https://guides.scalar.com/scalar/pricing
name: Scalar Pricing
- type: GitHub
url: https://github.com/scalar/scalar
name: Scalar GitHub Repository
- type: Discord
url: https://discord.gg/scalar
name: Scalar Discord Community
- type: Blog
url: https://scalar.com/blog
name: Scalar Blog
- type: ChangeLog
url: https://github.com/scalar/scalar/releases
name: Scalar Changelog
- type: Support
url: mailto:support@scalar.com
name: Scalar Support
- type: Dashboard
url: https://dashboard.scalar.com/
name: Scalar Dashboard
- type: LlmsText
url: https://docs.scalar.com/llms.txt
- type: GitHubOrganization
url: https://github.com/scalar
- type: Documentation
url: https://guides.scalar.com
apis:
- aid: scalar:scalar-api-references
name: Scalar API References
description: Scalar API References renders modern, interactive API documentation from OpenAPI and Swagger specifications.
Features include multiple themes, custom styling, dark mode, mobile responsiveness, built-in search, and an interactive
request panel for testing APIs directly in the docs. Supports OpenAPI 3.0 and 3.1, $ref resolution, allOf/oneOf/anyOf,
and authentication schemes. Framework integrations include React, Vue, FastAPI, ASP.NET Core, Spring Boot, NestJS, Express,
and 30+ others.
tags:
- Documentation
- Interactive
- OpenAPI
- References
- Swagger
humanURL: https://scalar.com/products/api-references/getting-started
properties:
- type: GettingStarted
url: https://scalar.com/products/api-references/getting-started
- type: Documentation
url: https://guides.scalar.com/scalar/scalar-api-references/getting-started
- type: GitHub
url: https://github.com/scalar/scalar
- type: NPM
url: https://www.npmjs.com/package/@scalar/api-reference
- aid: scalar:scalar-api-client
name: Scalar API Client
description: Scalar API Client is a fully open-source, offline-first REST API client built on the OpenAPI standard. Supports
collections, environments, pre/post-response scripting, test results, and collection runners. Available for Windows, macOS,
and Linux as a desktop application and as a browser-based version at client.scalar.com. Imports OpenAPI files to auto-generate
request collections with authentication pre-configured.
tags:
- API Client
- Collection
- OpenAPI
- REST
- Testing
- Developer Tools
- Open Source
tags_raw:
- API Client
- Collections
- OpenAPI
- REST
- Testing
- Developer Tools
- Open Source
- Open-Source
humanURL: https://scalar.com/products/api-client/getting-started
properties:
- type: GettingStarted
url: https://scalar.com/products/api-client/getting-started
- type: Application
url: https://client.scalar.com/
- type: Download
url: https://scalar.com/download
- type: GitHub
url: https://github.com/scalar/scalar
- url: https://guides.scalar.com/scalar/scalar-api-client/getting-started
type: Documentation
- url: https://github.com/scalar/scalar
type: SourceCode
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
- aid: scalar:scalar-docs
name: Scalar Docs
description: Scalar Docs enables teams to create and publish developer documentation that stays in sync with their API and
code. Supports writing with a WYSIWYG editor, pulling Markdown and MDX files from repositories, and generating API references
from OpenAPI documents with Git Sync and CI/CD integration. Custom domains, team collaboration, and versioning are available
on paid plans.
tags:
- Developer Portal
- Documentation
- Git Sync
- Markdown
- MDX
humanURL: https://scalar.com/products/docs/getting-started
properties:
- type: GettingStarted
url: https://scalar.com/products/docs/getting-started
- type: Portal
url: https://docs.scalar.com/
- type: Documentation
url: https://guides.scalar.com/scalar/scalar-docs/getting-started
- type: GitHubActions
url: https://scalar.com/products/docs/github-actions
- aid: scalar:scalar-registry
name: Scalar Registry
description: 'Scalar Registry provides centralized management and versioning of OpenAPI Documents, JSON Schemas, and Spectral
Rules with deep Git integration. Serves as the single source of truth for API definitions across teams. Supports both
private and public registries with CI/CD workflows via CLI and GitHub Actions. Publish via the scalar CLI: `scalar registry
publish`.'
tags:
- Git Integration
- Governance
- JSON Schema
- OpenAPI
- Registry
- Spectral
- Versioning
tags_raw:
- Git Integration
- Governance
- JSON Schema
- OpenAPI
- Registry
- Spectral
- Versioning
- JSON-Schema
humanURL: https://scalar.com/products/registry/getting-started
properties:
- type: GettingStarted
url: https://scalar.com/products/registry/getting-started
- type: Documentation
url: https://guides.scalar.com/scalar/scalar-registry/getting-started
- type: CLI
url: https://guides.scalar.com/scalar/scalar-cli/getting-started
- type: GitHubActions
url: https://scalar.com/scalar/scalar-registry/github-actions
- aid: scalar:scalar-sdks
name: Scalar SDKs
description: Scalar SDKs generates type-safe client libraries from OpenAPI specifications. Supported languages include TypeScript,
Python, Golang, PHP, Java, and Ruby. Features include automated GitHub workflows, code samples, full OpenAPI auth support,
file streaming, and webhook support. SDK generation is $100 per month per language on paid plans.
tags:
- Code Generation
- Go
- Java
- PHP
- Python
- Ruby
- SDK
- TypeScript
tags_raw:
- Code Generation
- Go
- Java
- PHP
- Python
- Ruby
- SDKs
- TypeScript
humanURL: https://scalar.com/products/sdks/getting-started
properties:
- type: GettingStarted
url: https://scalar.com/products/sdks/getting-started
- type: Documentation
url: https://guides.scalar.com/scalar/scalar-sdks/getting-started
- type: Pricing
url: https://guides.scalar.com/scalar/pricing
- aid: scalar:scalar-cli
name: Scalar CLI
description: The Scalar CLI is a command-line interface for managing OpenAPI files, generating documentation, running mock
servers, validating specs, and publishing to the Scalar Registry. Enables CI/CD integration and automation of the API
documentation workflow.
tags:
- CLI
- Developer Tools
- Mock Servers
- OpenAPI
- Validation
- Open Source
tags_raw:
- CLI
- Developer Tools
- Mock Server
- OpenAPI
- Validation
- Open Source
- Open-Source
humanURL: https://guides.scalar.com/scalar/scalar-cli/getting-started
properties:
- type: GettingStarted
url: https://guides.scalar.com/scalar/scalar-cli/getting-started
- type: Documentation
url: https://guides.scalar.com/scalar/scalar-cli/getting-started
- type: NPM
url: https://www.npmjs.com/package/@scalar/cli
- url: https://guides.scalar.com/scalar/scalar-registry/cli
type: Documentation
- url: https://www.npmjs.com/package/@scalar/cli
type: SourceCode
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
- aid: scalar:scalar-access-groups-api
name: Scalar Access Groups API
description: The access-groups API from Scalar — 5 operation(s) for access-groups.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Access Groups
tags_raw:
- access-groups
properties:
- type: OpenAPI
url: openapi/scalar-access-groups-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-access-group-schema.json
- type: JSONSchema
url: json-schema/scalar-email-schema.json
- type: JSONSchema
url: json-schema/scalar-email-domain-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-access-group-name-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-analytics-api
name: Scalar Analytics API
description: The analytics API from Scalar — 4 operation(s) for analytics.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Analytics
tags_raw:
- analytics
properties:
- type: OpenAPI
url: openapi/scalar-analytics-api-openapi.yml
- aid: scalar:scalar-api-docs-api
name: Scalar API Docs API
description: The api-docs API from Scalar — 13 operation(s) for api-docs.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Api Docs
tags_raw:
- api-docs
properties:
- type: OpenAPI
url: openapi/scalar-api-docs-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-managed-doc-schema.json
- type: JSONSchema
url: json-schema/scalar-managed-doc-version-schema.json
- type: JSONSchema
url: json-schema/scalar-method-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-auth-api
name: Scalar Auth API
description: The auth API from Scalar — 27 operation(s) for auth.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Authentication
tags_raw:
- auth
properties:
- type: OpenAPI
url: openapi/scalar-auth-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-identity-provider-record-schema.json
- type: JSONSchema
url: json-schema/scalar-user-schema.json
- type: JSONSchema
url: json-schema/scalar-token-response-schema.json
- type: JSONSchema
url: json-schema/scalar-email-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-docs-api
name: Scalar Docs API
description: The docs API from Scalar — 6 operation(s) for docs.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Docs
tags_raw:
- docs
properties:
- type: OpenAPI
url: openapi/scalar-docs-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-project-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-docs-projects-api
name: Scalar Docs Projects API
description: The Docs Projects API from Scalar — 9 operation(s) for docs projects.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Docs Projects
properties:
- type: OpenAPI
url: openapi/scalar-docs-projects-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-docs-project-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-forgejo-api
name: Scalar Forgejo API
description: The Forgejo API from Scalar — 1 operation(s) for forgejo.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Forgejo
properties:
- type: OpenAPI
url: openapi/scalar-forgejo-api-openapi.yml
- aid: scalar:scalar-github-api
name: Scalar Github API
description: The github API from Scalar — 16 operation(s) for github.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- GitHub
tags_raw:
- github
properties:
- type: OpenAPI
url: openapi/scalar-github-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-github-project-schema.json
- type: JSONSchema
url: json-schema/scalar-github-install-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- aid: scalar:scalar-internal-api
name: Scalar Internal API
description: The Internal API from Scalar — 1 operation(s) for internal.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Internal
properties:
- type: OpenAPI
url: openapi/scalar-internal-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-login-portals-api
name: Scalar Login Portals API
description: The login-portals API from Scalar — 3 operation(s) for login-portals.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- login-portals
properties:
- type: OpenAPI
url: openapi/scalar-login-portals-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-login-portal-page-schema.json
- type: JSONSchema
url: json-schema/scalar-login-portal-email-schema.json
- type: JSONSchema
url: json-schema/scalar-login-portal-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-payment-api
name: Scalar Payment API
description: The payment API from Scalar — 6 operation(s) for payment.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Payments
tags_raw:
- payment
properties:
- type: OpenAPI
url: openapi/scalar-payment-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-object-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-publish-api
name: Scalar Publish API
description: The publish API from Scalar — 11 operation(s) for publish.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Publish
tags_raw:
- publish
properties:
- type: OpenAPI
url: openapi/scalar-publish-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-publish-record-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-pubsub-api
name: Scalar Pubsub API
description: The pubsub API from Scalar — 7 operation(s) for pubsub.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Pub/Sub
tags_raw:
- pubsub
properties:
- type: OpenAPI
url: openapi/scalar-pubsub-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- type: JSONSchema
url: json-schema/scalar-version-schema.json
- aid: scalar:scalar-rules-api
name: Scalar Rules API
description: The rules API from Scalar — 6 operation(s) for rules.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Rules
tags_raw:
- rules
properties:
- type: OpenAPI
url: openapi/scalar-rules-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-schemas-api
name: Scalar Schemas API
description: The schemas API from Scalar — 7 operation(s) for schemas.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Schema
tags_raw:
- schemas
properties:
- type: OpenAPI
url: openapi/scalar-schemas-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-managed-schema-version-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-managed-schema-format-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- type: JSONSchema
url: json-schema/scalar-version-schema.json
- aid: scalar:scalar-share-api
name: Scalar Share API
description: The share API from Scalar — 1 operation(s) for share.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Share
tags_raw:
- share
properties:
- type: OpenAPI
url: openapi/scalar-share-api-openapi.yml
- aid: scalar:scalar-signup-api
name: Scalar Signup API
description: The signup API from Scalar — 1 operation(s) for signup.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Sign Up
tags_raw:
- signup
properties:
- type: OpenAPI
url: openapi/scalar-signup-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-project-version-schema.json
- type: JSONSchema
url: json-schema/scalar-theme-schema.json
- aid: scalar:scalar-team-api
name: Scalar Team API
description: The team API from Scalar — 36 operation(s) for team.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Team
tags_raw:
- team
properties:
- type: OpenAPI
url: openapi/scalar-team-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-project-schema.json
- type: JSONSchema
url: json-schema/scalar-feature-flag-schema.json
- type: JSONSchema
url: json-schema/scalar-custom-project-icon-schema.json
- type: JSONSchema
url: json-schema/scalar-team-billing-summary-schema.json
- type: JSONSchema
url: json-schema/scalar-team-list-mine-entry-schema.json
- type: JSONSchema
url: json-schema/scalar-email-schema.json
- aid: scalar:scalar-themes-api
name: Scalar Themes API
description: The themes API from Scalar — 4 operation(s) for themes.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Themes
tags_raw:
- themes
properties:
- type: OpenAPI
url: openapi/scalar-themes-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-theme-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-utility-api
name: Scalar Utility API
description: The utility API from Scalar — 3 operation(s) for utility.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Utility
tags_raw:
- utility
properties:
- type: OpenAPI
url: openapi/scalar-utility-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-project-version-schema.json
- type: JSONSchema
url: json-schema/scalar-theme-schema.json
- type: JSONSchema
url: json-schema/scalar-email-schema.json
- aid: scalar:scalar-vcs-api
name: Scalar VCS API
description: The vcs API from Scalar — 6 operation(s) for vcs.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- vcs
properties:
- type: OpenAPI
url: openapi/scalar-vcs-api-openapi.yml
- aid: scalar:scalar-waitlist-api
name: Scalar Waitlist API
description: The waitlist API from Scalar — 1 operation(s) for waitlist.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Waitlist
tags_raw:
- waitlist
properties:
- type: OpenAPI
url: openapi/scalar-waitlist-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-email-schema.json
- aid: scalar:scalar-workspace-api
name: Scalar Workspace API
description: The workspace API from Scalar — 6 operation(s) for workspace.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Workspace
tags_raw:
- workspace
properties:
- type: OpenAPI
url: openapi/scalar-workspace-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-workspace-schema.json
- type: JSONSchema
url: json-schema/scalar-workspace-version-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-version-schema.json
- aid: scalar:scalar-api-reference
x-published: false
name: Scalar API Reference
tags:
- API Reference
- API Documentation
- Open Source
- OpenAPI
tags_raw:
- API Reference
- API Documentation
- Open Source
- OpenAPI
- Open-Source
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://guides.scalar.com/scalar/scalar-api-references/getting-started
properties:
- url: https://guides.scalar.com/scalar/scalar-api-references/getting-started
type: Documentation
- url: https://github.com/scalar/scalar/blob/main/packages/api-reference/README.md
type: SourceCode
description: Open-source (MIT) renderer that turns an OpenAPI/Swagger or AsyncAPI document into an interactive API reference
with a built-in request-testing panel and multi-language code samples. Embeds from a single HTML file or as the @scalar/api-reference
npm package, and ships as the default docs UI in dozens of frameworks. This is a self-hosted component library, not a
hosted REST API - surface documented as a capability area (endpointsModeled).
- aid: scalar:scalar-docs-platform
x-published: false
name: Scalar Docs Platform
tags:
- API Documentation
- Developer Portal
- Git Sync
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://guides.scalar.com/scalar/scalar-docs/getting-started
properties:
- url: https://guides.scalar.com/scalar/scalar-docs/getting-started
type: Documentation
- url: https://scalar.com/products/docs/getting-started
type: SignUp
description: Hosted developer-portal product that combines Markdown/MDX guides with generated API references, custom domains
and subdomains, themes, versions, and two-way Git Sync from GitHub. Content is deployed via dashboard.scalar.com or automated
GitHub workflows. Hosted SaaS surface, not a public REST API (endpointsModeled).
- aid: scalar:scalar-sdk-generation
x-published: false
name: Scalar SDK Generation
tags:
- SDK
- Code Generation
- OpenAPI
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://scalar.com/products/sdks
properties:
- url: https://scalar.com/products/sdks
type: Documentation
description: Hosted SDK generation that produces type-safe client libraries from an OpenAPI document for TypeScript, Python,
Go, Java, PHP, C#, and Ruby, kept in sync with the registry. Paid add-on on the hosted platform (per-language). Generation
workflow, not a standalone public REST API (endpointsModeled).
- aid: scalar:scalar-agent-mcp
endpointsModeled: true
name: Scalar Agent and MCP
tags:
- Artificial Intelligence
- MCP
- Agents
- Developer Tools
tags_raw:
- AI
- MCP
- Agent
- Developer Tools
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://scalar.com/products/agent
properties:
- url: https://scalar.com/products/agent
type: Documentation
- url: https://scalar.com/products/agent/pricing
type: Plans
description: AI layer that lets developers chat with an API inside the docs and exposes hosted MCP (Model Context Protocol)
servers generated from an OpenAPI document so agents can call the API. Metered in Agent Scalar credits. Hosted AI/MCP
capability area (endpointsModeled).
- aid: scalar:scalar-sdks-api
name: Scalar SDKS API
description: The sdks API from Scalar — 18 operation(s) for sdks.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- SDK
tags_raw:
- sdks
properties:
- type: OpenAPI
url: openapi/scalar-sdks-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-sdk-preview-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-namespace-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- type: JSONSchema
url: json-schema/scalar-version-schema.json
- aid: scalar:scalar-mcp-servers-api
name: Scalar MCP Servers API
description: The mcp-servers API from Scalar — 5 operation(s) for mcp-servers.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- MCP Server
tags_raw:
- mcp-servers
properties:
- type: OpenAPI
url: openapi/scalar-mcp-servers-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-mcp-installation-schema.json
- type: JSONSchema
url: json-schema/scalar-mcp-server-schema.json
- type: JSONSchema
url: json-schema/scalar-slug-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-oauth-api
name: Scalar OAuth API
description: The OAuth API from Scalar — 7 operation(s) for oauth.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- OAuth
- Authentication
tags_raw:
- OAuth
- Authentication
properties:
- type: OpenAPI
url: openapi/scalar-oauth-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-oauth-client-created-schema.json
- type: JSONSchema
url: json-schema/scalar-oauth-client-list-item-schema.json
- type: JSONSchema
url: json-schema/scalar-oauth-authorization-request-view-schema.json
- type: JSONSchema
url: json-schema/scalar-oauth-token-request-schema.json
- type: JSONSchema
url: json-schema/scalar-oauth-client-create-schema.json
- type: JSONSchema
url: json-schema/scalar-oauth-authorize-result-schema.json
- aid: scalar:scalar-registry-git-api
name: Scalar Registry Git API
description: The registry-git API from Scalar — 11 operation(s) for registry-git.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- registry-git
properties:
- type: OpenAPI
url: openapi/scalar-registry-git-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-doc-source-schema.json
- type: JSONSchema
url: json-schema/scalar-registry-publish-schema.json
- type: JSONSchema
url: json-schema/scalar-registry-git-binding-schema.json
- type: JSONSchema
url: json-schema/scalar-linked-repository-schema.json
- type: JSONSchema
url: json-schema/scalar-version-schema.json
- aid: scalar:scalar-user-info-hooks-api
name: Scalar User Info Hooks API
description: The user-info-hooks API from Scalar — 2 operation(s) for user-info-hooks.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- user-info-hooks
properties:
- type: OpenAPI
url: openapi/scalar-user-info-hooks-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- aid: scalar:scalar-webhooks-api
name: Scalar Webhooks API
description: Register endpoints for platform events, and inspect what was delivered to them.
humanURL: https://scalar.com/products/api-references/getting-started
tags:
- Webhook
tags_raw:
- webhooks
properties:
- type: OpenAPI
url: openapi/scalar-webhooks-api-openapi.yml
- type: JSONSchema
url: json-schema/scalar-timestamp-schema.json
- type: JSONSchema
url: json-schema/scalar-nanoid-schema.json
- type: JSONSchema
url: json-schema/scalar-webhook-delivery-status-schema.json
- type: JSONSchema
url: json-schema/scalar-webhook-disabled-reason-schema.json
- type: JSONSchema
url: json-schema/scalar-webhook-event-schema.json
segments:
- SDKs
- Clients
- Documentation
- Registries
- Developer Tools
integrations:
- name: API References Animation
- name: API Registry Animation
- name: SDK Animation
- name: Client Animation
- name: Registry
- name: API Client
- name: API Client Preview
- name: SDKs Preview
- name: API Registry Preview
- name: API Docs Preview
- name: logo
x-enrichment:
date: '2026-10-10'
status: enriched
artifacts_added: 87
pass: modular-v1
engine: identity=local,contract=local,surfaces=local,docs=local,regulatory=local
Scalar API — frequently asked questions
Does Scalar have an API?
Yes. APIs.io lists 39 APIs from Scalar, including Scalar API References, Scalar API Client and Scalar Docs, and 36 more.
Is there an OpenAPI specification for the Scalar API?
Yes. APIs.io indexes 29 OpenAPI specifications for Scalar, each linked for download from this page.
How do I authenticate with the Scalar API?
Scalar documents its authentication (http · 1 scheme). The details are profiled on APIs.io as Scalar Authentication.
How much does the Scalar API cost?
Scalar publishes its prices; its Free plan is $0 as of 2026-10-28. APIs.io lists 6 pricing plans for Scalar, with each plan's price, limits and inclusions under Pricing on this page.
Does Scalar have an MCP server?
Yes. APIs.io lists 1 MCP server for Scalar: Remote MCP server at scalar.com over HTTP; 1 tool listed.
Is the Scalar API ready for AI agents?
Scalar has a Kin Score of 68.5 out of 100 (exemplar) and an Agent Readiness score of 54.6 (agent-ready), scored by API Evangelist on 2026-11-06.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: