1
Check what you need
You need Python 3.10 or newer and
git.- macOS
- Linux
- Windows
2
Pick an API and start it
3
Open its API reference
Choose the matching tab at the top of this site, pick an endpoint, and click Try it. The playground sends the request from your browser straight to
http://localhost:8000.4
Send a request
For the Todo API, enter
demo-key as the API key. Every other API needs no key.You’re running a real API and calling it from generated docs.
Troubleshooting
The playground says it can't reach the server
The playground says it can't reach the server
Make sure the API is running and shows
Uvicorn running on http://127.0.0.1:8000. The APIs allow cross-origin requests, so no extra setup is needed.pip install fails
pip install fails
Check that you activated the virtual environment: your prompt should start with
(.venv).Port 8000 is already in use
Port 8000 is already in use
Stop the other API, or run
uvicorn main:app --port 8001.How this site is built
Each API’s code and tests live in that API’s repository. All of the docs, including each API’s guides and OpenAPI spec, live in the docs repository. When an API’s code changes, Mintlify’s agent opens a pull request in the docs repository with the matching docs update.Components
Every building block used on this site.
AI features
The assistant, llms.txt, the MCP server and more.