Get a Stoplight projectLook up a public Stoplight project - the thing Elements Dev Portal renders - by its ID, its workspace and name, or the address of its docs, and get back its name, its workspace, the address of its hosted docs, its ID for the steps after, and every version of its docs with the default one marked. The step to start from. No account or API key required.
List a project's pagesList the pages of a public Stoplight project's docs - its articles, APIs, endpoints, webhooks and models - in the order its sidebar shows them, with the divider and folders each is filed under, the API it belongs to, each endpoint's method, and its address in the docs. Narrow it to one kind of page, one API or some text, on any branch. The way to find a page's slug, build an endpoint inventory, or loop over a project. No account or API key required.
Get a pageRead one page of a public Stoplight project's docs, as Elements Dev Portal shows it: an article's Markdown; an API's version, servers and security; an endpoint's method and path, parameters, request body and every response with its schema and examples; or a model's JSON Schema. Comes with the pages it links to, its mock server's address and its Export links. Name it by its slug, its ID or its address in the docs. The detail to hand an AI step writing a client, a test or a summary. No account or API key required.
Search a project's docsSearch everything a public Stoplight project's docs say - titles, summaries and text - the way Elements Dev Portal's search box does, and get back the matching pages with the passage that matched and each page's address. The way to find where the docs cover a topic, or to hand an AI step the right page. No account or API key required.
Save an API's document as a fileSave an API's OpenAPI document - or a model's JSON Schema - from a public Stoplight project as a file, the way the docs' Export button does: bundled, with every reference to another file copied in so it stands alone, or the original file as it is. A later step can commit it, attach it, feed it to a code generator or build an API reference page from it. No account or API key required.
Call a mock serverSend a request to an endpoint's hosted mock server - Stoplight's Prism, answering from the API's own docs - and get back what the API would answer: the status, headers and body, before the API itself exists or without touching it. Fills in whatever the step leaves out from the endpoint's examples, and a stand-in credential where one is needed, which the result lists. Ask for a documented status code, a named example or freshly generated data, as Try It's mocking menu does. No account or API key required.
Create an API reference pageBuild a standalone web page that renders an OpenAPI document as Stoplight Elements' interactive API reference - a sidebar of endpoints and models, request samples and a Try It console - ready to upload to any static host, attach to an email or publish from a later step. Pick the layout, a title and a logo, and which parts to leave out. 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.
Create a developer portal pageBuild a standalone web page that renders a whole public Stoplight project with Elements Dev Portal - its articles and guides, every API, endpoint and model, the version picker, Try It and the hosted mock servers - ready to upload to any static host or embed in a site. The page reads the project live from Stoplight each time it is opened, so it stays current. Stoplight lets anyone use the Dev Portal while developing on their own machine; serving it from a live site needs the project's workspace on a paid Stoplight plan. No account or API key required to build it.
