# Metal

> Developer documentation and API reference for Metal, the AI context layer for financial firms.

## Docs

- [Create an API key](https://docs.metal.ai/api-reference/api-keys/create-an-api-key.md): Creates a new API key. The secret `key` is returned only once in this response — store it securely.
- [Delete an API key](https://docs.metal.ai/api-reference/api-keys/delete-an-api-key.md): Revokes an API key immediately. The key stops working within a short cache window.
- [List API keys](https://docs.metal.ai/api-reference/api-keys/list-api-keys.md): Returns metadata for every API key in your organization. Secret values are never returned after creation.
- [Create a company](https://docs.metal.ai/api-reference/companies/create-a-company.md): Creates a company. Only `canonicalName` is required.
- [Delete a company](https://docs.metal.ai/api-reference/companies/delete-a-company.md): Deletes a company by id.
- [Enrich a company](https://docs.metal.ai/api-reference/companies/enrich-a-company.md): Triggers asynchronous enrichment for a company. Enriched values appear on the record once processing completes; poll the company to read them.
- [Get a company](https://docs.metal.ai/api-reference/companies/get-a-company.md): Retrieves a single company by id.
- [List companies](https://docs.metal.ai/api-reference/companies/list-companies.md): Returns companies in your organization, newest first. Supports pagination and sorting.
- [Search companies](https://docs.metal.ai/api-reference/companies/search-companies.md): Returns companies ranked by relevance to a query.
- [Update a company](https://docs.metal.ai/api-reference/companies/update-a-company.md): Updates an existing company. Provide the fields you want to change.
- [Create a deal](https://docs.metal.ai/api-reference/deals/create-a-deal.md): Creates a deal. Provide a `name` and, typically, the target `companyId`.
- [Delete a deal](https://docs.metal.ai/api-reference/deals/delete-a-deal.md): Deletes a deal by id.
- [Get a deal](https://docs.metal.ai/api-reference/deals/get-a-deal.md): Retrieves a single deal by id.
- [List deals](https://docs.metal.ai/api-reference/deals/list-deals.md): Returns deals in your organization, newest first.
- [Search deals](https://docs.metal.ai/api-reference/deals/search-deals.md): Returns deals ranked by relevance to a query.
- [Update a deal](https://docs.metal.ai/api-reference/deals/update-a-deal.md): Updates an existing deal.
- [Search documents](https://docs.metal.ai/api-reference/documents/search-documents.md): Searches across the content of documents ingested into Metal, ranked by relevance.
- [API reference](https://docs.metal.ai/api-reference/introduction.md): Conventions, authentication, and structure of the Metal REST API.
- [Add an entry](https://docs.metal.ai/api-reference/lists/add-an-entry.md): Adds a resource to a list as a new entry.
- [Create a list](https://docs.metal.ai/api-reference/lists/create-a-list.md): Creates a new list.
- [Delete a list](https://docs.metal.ai/api-reference/lists/delete-a-list.md): Deletes a list by id.
- [Get a list](https://docs.metal.ai/api-reference/lists/get-a-list.md): Retrieves a single list by id, including its column configuration.
- [List entries](https://docs.metal.ai/api-reference/lists/list-entries.md): Returns the entries (rows) in a list.
- [List lists](https://docs.metal.ai/api-reference/lists/list-lists.md): Returns the lists in your organization.
- [Update a list](https://docs.metal.ai/api-reference/lists/update-a-list.md): Updates a list's metadata.
- [Create a person](https://docs.metal.ai/api-reference/people/create-a-person.md): Creates a person. Provide at least a name; link to a company with `company`.
- [Delete a person](https://docs.metal.ai/api-reference/people/delete-a-person.md): Deletes a person by id.
- [Get a person](https://docs.metal.ai/api-reference/people/get-a-person.md): Retrieves a single person by id.
- [List people](https://docs.metal.ai/api-reference/people/list-people.md): Returns people in your organization, newest first.
- [Search people](https://docs.metal.ai/api-reference/people/search-people.md): Returns people ranked by relevance to a query.
- [Update a person](https://docs.metal.ai/api-reference/people/update-a-person.md): Updates an existing person.
- [Create a workflow](https://docs.metal.ai/api-reference/workflows/create-a-workflow.md): Creates a new workflow definition.
- [Get a workflow](https://docs.metal.ai/api-reference/workflows/get-a-workflow.md): Retrieves a single workflow definition by id.
- [Get a workflow run](https://docs.metal.ai/api-reference/workflows/get-a-workflow-run.md): Retrieves a single workflow run by id, including its status and output.
- [List workflow runs](https://docs.metal.ai/api-reference/workflows/list-workflow-runs.md): Returns runs for a workflow, newest first.
- [List workflows](https://docs.metal.ai/api-reference/workflows/list-workflows.md): Returns the workflows in your organization.
- [Trigger a workflow run](https://docs.metal.ai/api-reference/workflows/trigger-a-workflow-run.md): Starts a new run of the workflow with the provided input. Runs are asynchronous; poll the run to track completion.
- [Authentication](https://docs.metal.ai/authentication.md): Authenticate Metal API requests with API keys.
- [Data model](https://docs.metal.ai/concepts/data-model.md): Companies, deals, people, and how Metal's core resources relate.
- [Enrichment](https://docs.metal.ai/concepts/enrichment.md): Enrich companies with AI-sourced firmographics, financials, and signals.
- [Platform overview](https://docs.metal.ai/concepts/platform.md): How Metal structures a firm's knowledge into an AI-ready context layer.
- [Workflows](https://docs.metal.ai/concepts/workflows.md): Automate multi-step research and work product with Metal AI workflows.
- [Errors](https://docs.metal.ai/guides/errors.md): HTTP status codes, error response format, and how to handle failures.
- [Pagination](https://docs.metal.ai/guides/pagination.md): Page through large collections with page, limit, and cursor parameters.
- [Rate limits](https://docs.metal.ai/guides/rate-limits.md): How Metal rate limits API requests and how to handle 429 responses.
- [Search](https://docs.metal.ai/guides/search.md): Retrieve relevant companies, deals, people, and documents with search.
- [Webhooks](https://docs.metal.ai/guides/webhooks.md): Trigger Metal workflows from external systems with webhook triggers.
- [Metal](https://docs.metal.ai/index.md): Build on Metal, the AI context layer for financial firms.
- [Connect ChatGPT](https://docs.metal.ai/mcp/chatgpt.md): Add the Metal MCP server to ChatGPT as a connector.
- [Connect Claude](https://docs.metal.ai/mcp/claude.md): Add the Metal MCP server to Claude as a custom connector.
- [Other MCP clients](https://docs.metal.ai/mcp/clients.md): Connect any MCP-compatible tool to the Metal MCP server.
- [Connect Cursor](https://docs.metal.ai/mcp/cursor.md): Add the Metal MCP server to Cursor.
- [Metal MCP server](https://docs.metal.ai/mcp/overview.md): Connect MCP-compatible AI tools to Metal with the hosted Metal MCP server.
- [Quickstart](https://docs.metal.ai/quickstart.md): Create an API key and make your first request to the Metal API.

## OpenAPI Specs

- [openapi](https://docs.metal.ai/api-reference/openapi.json)