# Metal

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

## Docs

- [List activities for a company](https://docs.metal.ai/api-reference/activities/list-activities-for-a-company.md): Returns activities linked to a company.
- [Search activities](https://docs.metal.ai/api-reference/activities/search-activities.md): Returns activities ranked by relevance to a query.
- [Create a activity](https://docs.metal.ai/api-reference/activity/create-a-activity.md): Creates a new activity.
- [Delete a activity](https://docs.metal.ai/api-reference/activity/delete-a-activity.md): Deletes a activity by id.
- [Get a activity](https://docs.metal.ai/api-reference/activity/get-a-activity.md): Retrieves a single activity by id.
- [List activities](https://docs.metal.ai/api-reference/activity/list-activities.md): Returns activities in your organization.
- [Update a activity](https://docs.metal.ai/api-reference/activity/update-a-activity.md): Updates an existing activity.
- [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, so 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.
- [Get current API key](https://docs.metal.ai/api-reference/api-keys/get-current-api-key.md): Returns metadata for the API key used to authenticate this request.
- [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. Metal gathers candidate values from your documents, data providers, and the web, then ranks and reconciles them into a single value per attribute. Enriched values appear on the record once processing completes; poll the company to read them, and inspec…
- [Get a company](https://docs.metal.ai/api-reference/companies/get-a-company.md): Retrieves a single company by id.
- [Get a company by external id](https://docs.metal.ai/api-reference/companies/get-a-company-by-external-id.md): Retrieves a company using your own external identifier.
- [Get a company by external reference](https://docs.metal.ai/api-reference/companies/get-a-company-by-external-reference.md): Retrieves a company by its external source reference.
- [Get companies by ids](https://docs.metal.ai/api-reference/companies/get-companies-by-ids.md): Retrieves multiple companies in a single request.
- [List companies](https://docs.metal.ai/api-reference/companies/list-companies.md): Returns companies in your organization, newest first. Supports pagination and sorting.
- [List company financial metrics](https://docs.metal.ai/api-reference/companies/list-company-financial-metrics.md): Returns financial metrics extracted for a company.
- [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.
- [Batch resolve observations](https://docs.metal.ai/api-reference/data/batch-resolve-observations.md): Resolves up to 32 observations in a single request.
- [Get a metric series](https://docs.metal.ai/api-reference/data/get-a-metric-series.md): Returns a time series of metric observations for a resource and key.
- [Get an observation](https://docs.metal.ai/api-reference/data/get-an-observation.md): Resolves the best observation value for a resource and key.
- [List available metrics](https://docs.metal.ai/api-reference/data/list-available-metrics.md): Returns the metric keys available for a resource.
- [Query a metric series](https://docs.metal.ai/api-reference/data/query-a-metric-series.md): Returns a metric time series with advanced period and candidate filters.
- [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.
- [Get a deal by external id](https://docs.metal.ai/api-reference/deals/get-a-deal-by-external-id.md): Retrieves a deal using your own external identifier.
- [Get deals by ids](https://docs.metal.ai/api-reference/deals/get-deals-by-ids.md): Retrieves multiple deals in a single request.
- [List deals](https://docs.metal.ai/api-reference/deals/list-deals.md): Returns deals in your organization, newest first.
- [List deals for a company](https://docs.metal.ai/api-reference/deals/list-deals-for-a-company.md): Returns deals associated with a company.
- [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.
- [Get documents by ids](https://docs.metal.ai/api-reference/documents/get-documents-by-ids.md): Retrieves multiple documents in a single request.
- [Search documents](https://docs.metal.ai/api-reference/documents/search-documents.md): Searches across the content of documents ingested into Metal, ranked by relevance.
- [Create an enrichment](https://docs.metal.ai/api-reference/enrichments/create-an-enrichment.md): Records an enriched property value on a resource.
- [Delete an enrichment](https://docs.metal.ai/api-reference/enrichments/delete-an-enrichment.md): Deletes an enrichment value by id.
- [Get enrichment for a property](https://docs.metal.ai/api-reference/enrichments/get-enrichment-for-a-property.md): Returns the top enrichment value for a specific property on a resource.
- [List enrichments for a resource](https://docs.metal.ai/api-reference/enrichments/list-enrichments-for-a-resource.md): Returns all enrichment values for a resource.
- [Create a industry](https://docs.metal.ai/api-reference/industry/create-a-industry.md): Creates a new industry.
- [Delete a industry](https://docs.metal.ai/api-reference/industry/delete-a-industry.md): Deletes a industry by id.
- [Get a industry](https://docs.metal.ai/api-reference/industry/get-a-industry.md): Retrieves a single industry by id.
- [List industries](https://docs.metal.ai/api-reference/industry/list-industries.md): Returns industries in your organization.
- [Update a industry](https://docs.metal.ai/api-reference/industry/update-a-industry.md): Updates an existing industry.
- [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.
- [Delete a list entry](https://docs.metal.ai/api-reference/lists/delete-a-list-entry.md): Removes an entry from a list.
- [Enrich a list](https://docs.metal.ai/api-reference/lists/enrich-a-list.md): Triggers enrichment for all entries in a list.
- [Get a list](https://docs.metal.ai/api-reference/lists/get-a-list.md): Retrieves a single list by id, including its column configuration.
- [Get a list entry](https://docs.metal.ai/api-reference/lists/get-a-list-entry.md): Retrieves a single entry from a list.
- [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.
- [Update a list entry](https://docs.metal.ai/api-reference/lists/update-a-list-entry.md): Updates an entry in a list.
- [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.
- [Get a person by external reference](https://docs.metal.ai/api-reference/people/get-a-person-by-external-reference.md): Retrieves a person by their external source reference.
- [Get people by ids](https://docs.metal.ai/api-reference/people/get-people-by-ids.md): Retrieves multiple people in a single request.
- [List people](https://docs.metal.ai/api-reference/people/list-people.md): Returns people in your organization, newest first.
- [List people for a company](https://docs.metal.ai/api-reference/people/list-people-for-a-company.md): Returns people linked to a company.
- [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 score](https://docs.metal.ai/api-reference/scores/create-a-score.md): Records a score against a scoring framework.
- [Delete a score](https://docs.metal.ai/api-reference/scores/delete-a-score.md): Deletes a score by id.
- [Get a score](https://docs.metal.ai/api-reference/scores/get-a-score.md): Retrieves a single score by id.
- [Get a scoring framework](https://docs.metal.ai/api-reference/scores/get-a-scoring-framework.md): Retrieves a scoring framework by id.
- [List scores](https://docs.metal.ai/api-reference/scores/list-scores.md): Returns scores in your organization.
- [List scores for a company](https://docs.metal.ai/api-reference/scores/list-scores-for-a-company.md): Returns scores associated with a company.
- [List scoring frameworks](https://docs.metal.ai/api-reference/scores/list-scoring-frameworks.md): Returns scoring frameworks in your organization.
- [Create a screening](https://docs.metal.ai/api-reference/screening/create-a-screening.md): Creates a new screening.
- [Delete a screening](https://docs.metal.ai/api-reference/screening/delete-a-screening.md): Deletes a screening by id.
- [Get a screening](https://docs.metal.ai/api-reference/screening/get-a-screening.md): Retrieves a single screening by id.
- [List screenings](https://docs.metal.ai/api-reference/screening/list-screenings.md): Returns screenings in your organization.
- [Update a screening](https://docs.metal.ai/api-reference/screening/update-a-screening.md): Updates an existing screening.
- [List screenings for a company](https://docs.metal.ai/api-reference/screenings/list-screenings-for-a-company.md): Returns screenings associated with a company.
- [List screenings for a deal](https://docs.metal.ai/api-reference/screenings/list-screenings-for-a-deal.md): Returns screenings associated with a deal.
- [Search screenings](https://docs.metal.ai/api-reference/screenings/search-screenings.md): Returns screenings ranked by relevance to a query.
- [Create a sector](https://docs.metal.ai/api-reference/sector/create-a-sector.md): Creates a new sector.
- [Delete a sector](https://docs.metal.ai/api-reference/sector/delete-a-sector.md): Deletes a sector by id.
- [Get a sector](https://docs.metal.ai/api-reference/sector/get-a-sector.md): Retrieves a single sector by id.
- [List sectors](https://docs.metal.ai/api-reference/sector/list-sectors.md): Returns sectors in your organization.
- [Update a sector](https://docs.metal.ai/api-reference/sector/update-a-sector.md): Updates an existing sector.
- [Create a subsector](https://docs.metal.ai/api-reference/subsector/create-a-subsector.md): Creates a new subsector.
- [Delete a subsector](https://docs.metal.ai/api-reference/subsector/delete-a-subsector.md): Deletes a subsector by id.
- [Get a subsector](https://docs.metal.ai/api-reference/subsector/get-a-subsector.md): Retrieves a single subsector by id.
- [List subsectors](https://docs.metal.ai/api-reference/subsector/list-subsectors.md): Returns subsectors in your organization.
- [Update a subsector](https://docs.metal.ai/api-reference/subsector/update-a-subsector.md): Updates an existing subsector.
- [Create a tag](https://docs.metal.ai/api-reference/tag/create-a-tag.md): Creates a new tag.
- [Delete a tag](https://docs.metal.ai/api-reference/tag/delete-a-tag.md): Deletes a tag by id.
- [Get a tag](https://docs.metal.ai/api-reference/tag/get-a-tag.md): Retrieves a single tag by id.
- [List tags](https://docs.metal.ai/api-reference/tag/list-tags.md): Returns tags in your organization.
- [Update a tag](https://docs.metal.ai/api-reference/tag/update-a-tag.md): Updates an existing tag.
- [Create a team](https://docs.metal.ai/api-reference/team/create-a-team.md): Creates a new team.
- [Delete a team](https://docs.metal.ai/api-reference/team/delete-a-team.md): Deletes a team by id.
- [Get a team](https://docs.metal.ai/api-reference/team/get-a-team.md): Retrieves a single team by id.
- [List teams](https://docs.metal.ai/api-reference/team/list-teams.md): Returns teams in your organization.
- [Update a team](https://docs.metal.ai/api-reference/team/update-a-team.md): Updates an existing team.
- [List team members](https://docs.metal.ai/api-reference/teams/list-team-members.md): Returns users who are members of a team.
- [Cancel a workflow run](https://docs.metal.ai/api-reference/workflows/cancel-a-workflow-run.md): Cancels a running or queued workflow run.
- [Create a workflow](https://docs.metal.ai/api-reference/workflows/create-a-workflow.md): Creates a new workflow definition.
- [Delete a workflow](https://docs.metal.ai/api-reference/workflows/delete-a-workflow.md): Deletes a workflow by id.
- [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 all workflow runs](https://docs.metal.ai/api-reference/workflows/list-all-workflow-runs.md): Returns workflow runs across your organization, newest first.
- [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.
- [Retry a workflow run](https://docs.metal.ai/api-reference/workflows/retry-a-workflow-run.md): Retries a failed workflow run.
- [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.
- [Update a workflow](https://docs.metal.ai/api-reference/workflows/update-a-workflow.md): Updates a workflow definition.
- [Create a workspace](https://docs.metal.ai/api-reference/workspace/create-a-workspace.md): Creates a new workspace.
- [Delete a workspace](https://docs.metal.ai/api-reference/workspace/delete-a-workspace.md): Deletes a workspace by id.
- [Get a workspace](https://docs.metal.ai/api-reference/workspace/get-a-workspace.md): Retrieves a single workspace by id.
- [List workspaces](https://docs.metal.ai/api-reference/workspace/list-workspaces.md): Returns workspaces in your organization.
- [Update a workspace](https://docs.metal.ai/api-reference/workspace/update-a-workspace.md): Updates an existing workspace.
- [Search workspaces](https://docs.metal.ai/api-reference/workspaces/search-workspaces.md): Returns workspaces ranked by relevance to a query.
- [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.
- [Financial metrics](https://docs.metal.ai/concepts/financial-metrics.md): The financial attributes Metal enriches on companies, and how they're sourced and reconciled.
- [Platform overview](https://docs.metal.ai/concepts/platform.md): How Metal structures a firm's knowledge into an AI-ready context layer.
- [Reconciliation & ranking](https://docs.metal.ai/concepts/reconciliation.md): How Metal ranks discovered values from many sources and reconciles them into one trusted value.
- [Workflows](https://docs.metal.ai/concepts/workflows.md): Automate multi-step research and work product with Metal AI workflows.
- [Automate research with workflows](https://docs.metal.ai/guides/automate-workflows.md): Run Metal AI workflows from the API, track runs, and trigger them from events.
- [Enrich companies](https://docs.metal.ai/guides/enrich-companies.md): Trigger AI enrichment, track its progress, and enrich records in bulk.
- [Errors](https://docs.metal.ai/guides/errors.md): HTTP status codes, error response format, and how to handle failures.
- [Build and manage lists](https://docs.metal.ai/guides/manage-lists.md): Group companies, deals, and people into lists to work with them in bulk.
- [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.
- [Sync your data](https://docs.metal.ai/guides/sync-data.md): Create and keep companies, deals, and people in sync with your own systems.
- [Webhooks](https://docs.metal.ai/guides/webhooks.md): Trigger Metal workflows from external systems with webhook triggers.
- [Onboarding your workspace](https://docs.metal.ai/help/admin/onboarding.md): Set up Metal for your firm for the first time.
- [Roles & permissions](https://docs.metal.ai/help/admin/roles.md): The roles in Metal and what each can do.
- [Workspace settings](https://docs.metal.ai/help/admin/settings.md): Find your way around Metal's settings.
- [Taxonomy](https://docs.metal.ai/help/admin/taxonomy.md): Configure deal stages, statuses, and the labels Metal uses to classify your data.
- [Adding & managing users](https://docs.metal.ai/help/admin/users.md): Request new members, create placeholder users, and organize people into teams.
- [Working with companies](https://docs.metal.ai/help/companies.md): Add companies, organize their files, and read enriched profiles.
- [Key concepts](https://docs.metal.ai/help/concepts.md): The core building blocks of Metal, explained in plain language.
- [Working with deals](https://docs.metal.ai/help/deals.md): Create deals, assign target companies, move them through stages on the Active Pipeline, assign owners, and attach documents in Metal.
- [Files & documents](https://docs.metal.ai/help/documents.md): Upload files to Metal and make their contents searchable.
- [Enrichment](https://docs.metal.ai/help/enrichment.md): Let Metal fill in firmographics, financials, and signals with AI.
- [Welcome to Metal](https://docs.metal.ai/help/index.md): Get oriented in the Metal app and find your way around the user guide.
- [CRM integration](https://docs.metal.ai/help/integrations/crm.md): Connect Metal to your CRM to keep deals and companies in sync.
- [File storage integration](https://docs.metal.ai/help/integrations/file-storage.md): Connect file storage so documents flow into Metal and become searchable.
- [Integrations overview](https://docs.metal.ai/help/integrations/overview.md): Connect Metal to your file storage, CRM, and other systems.
- [Working with lists](https://docs.metal.ai/help/lists.md): Group records into lists and enrich or compute columns across them.
- [Navigating Metal](https://docs.metal.ai/help/navigating.md): Find your way around the Metal app — the sidebar, search, and your account menu.
- [Working with people](https://docs.metal.ai/help/people.md): Add contacts and executives and link them to companies.
- [Searching in Metal](https://docs.metal.ai/help/search.md): Use the command palette and Files search to find what you need.
- [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.
- [MCP tools reference](https://docs.metal.ai/mcp/tools-reference.md): Tool names, parameters, response shapes, and call examples for the 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)