Skip to main content

REST

Follow the patterns in your OpenAPI document: header-based API keys, signatures, or bearer tokens, depending on what the backend exposes. Configure credentials in the API playground using the auth scheme defined in specs/openapi.json. When you extend the spec with securitySchemes and security, Mintlify will surface those inputs automatically.

WebSockets

If the private stream requires credentials, send the required headers or query parameters when opening the WebSocket (per your gateway). Document any User-Agent, API key, or session requirements here as your backend team finalizes them.