Metal documentation

Developer documentation and API reference for Metal, the AI context layer for financial firms. Built on Mintlify.

Structure

• docs.json — site configuration (branding, theme, navigation).
• index.mdx, quickstart.mdx, authentication.mdx — getting started.
• concepts/ — platform overview and core concepts.
• guides/ — pagination, errors, rate limits, search, webhooks.
• api-reference/ — API reference overview and the OpenAPI spec (openapi.json).
• logo/, favicon.png — brand assets.

Editing the API reference

The API reference is generated from api-reference/openapi.json (OpenAPI 3.1). To add or change an endpoint:

1. Edit api-reference/openapi.json.
2. Reference the operation in docs.json navigation as "METHOD /path" (for example, "GET /v1/companies").

Development

Install the Mintlify CLI:

npm i -g mint

Run a local preview from the repo root (where docs.json lives):

mint dev

Validate the configuration and check links:

mint validate
mint broken-links

View the local preview at http://localhost:3000.

Publishing

Changes are deployed automatically after they merge to the default branch via the Mintlify GitHub app.

Resources

• Mintlify documentation
• Metal