Get an API documentFetch an API's OpenAPI or AsyncAPI document from the Scalar Registry - or from any public address that serves one as JSON - and get back the whole document alongside what its docs open with: the title and version, the description, the servers, the tags, how many operations and models it has, its security schemes, and the Registry addresses of the document as JSON and YAML. The step to start from when a workflow checks an API for changes, catalogues it, or hands it to an AI step. No account or API key required.
Save an API document as a fileSave an API's document from the Scalar Registry as a JSON or YAML file, written by the Registry itself, so a later step can commit it to a repository, attach it to an email, upload it to storage or feed it to a code generator. Pin a version to keep a copy of exactly that one. No account or API key required.
List an API's operationsList the operations an API's docs show - method, path, operationId, summary, tags, whether each needs credentials and which, its parameters and the status codes it documents - in the document's order, the way Scalar's API Reference reads it: operations the document hides are left out. Narrow it to a tag, a method or some text, a page at a time. The way to build an endpoint inventory, find what changed between versions, or loop over every endpoint. No account or API key required.
Get an operationRead everything an API's docs say about one operation: its summary and description, the servers it is called on, the credentials it takes, each parameter with its type and an example, the request body and every response with their schemas and examples, and a ready-to-run curl command written the way Scalar's own code sample writes it. Name it by operationId, or as METHOD /path. The detail to hand an AI step writing a client, a test or a changelog entry. No account or API key required.
Get a modelRead one of an API's models - the named schemas its docs list under Models - property by property: each one's type, format, description and example, which are required, read-only or write-only, and the values an enum allows. Comes with the full schema and an example object built the way the docs build one: the thing to hand a step that generates test data or validates a payload. No account or API key required.
Get a JSON SchemaFetch a public JSON Schema from the Scalar Registry - the shared models teams publish there to reference from their APIs - with its title, its properties and which are required, and the address to put in a $ref or $schema. Validate data against it in a later step, or check it for changes. No account or API key required.
Share an API reference for a weekTurn an OpenAPI or AsyncAPI document into interactive API docs on Scalar and get back a link anyone can open - searchable, with every endpoint, model and a 'Test Request' button - without an account. It is what the Share button in Scalar's own API Reference does. Scalar deletes the upload seven days after it is made, so it suits a review, a pull request or a demo; the link to publish for good is a Scalar Docs site. The document can be a file, its text, an earlier step's result or a public address. No account or API key required.
Create an API reference pageBuild a standalone web page that renders an OpenAPI or AsyncAPI document as Scalar's interactive API reference - the same page Scalar's own server integrations serve - ready to upload to any static host, attach to an email or publish from a later step. Pick a theme and layout, dark mode, a title and custom CSS, and whether to show models, operation IDs and the 'Test Request' button. A document given by address is loaded fresh each time the page is opened; one given as a file or text is written into the page. Nothing is sent anywhere to build it. No account or API key required.
Send a test requestSend a request to Scalar's request mirror and get back exactly what arrived: the method and path, the query values, every header, the cookies, the body as the server parsed it, and any bearer token or username and password it found in the Authorization header. The step to point a half-built workflow at to see what it really sends before it sends it anywhere that matters. No account or API key required.
