Metaphor integration: operations for AI agents
Metaphor connects to Type.com as an integration. This page lists the 69 operations documented for Claude and Codex in Type.com: 32 read, 21 write, 16 destructive.
About Metaphor
Metaphor is a neural search engine that enables developers to perform contextually relevant searches by understanding how people describe and share content online.
Categories: Analytics & Data
How to connect Metaphor to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
69 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
69 operations listed.
Search
- Read
Search
Perform a search with an Exa prompt-engineered query and retrieve a list of relevant results. Optionally get contents.
Contents
- Write
Contents
POST /contents
Answer
- Write
Answer
Performs a search based on the query and generates either a direct answer or a detailed summary with citations, depending on the query type.
Monitors
- Read
List monitors
Lists all monitors for the authenticated team. Supports filtering by status and cursor-based pagination.
- Read
Get a monitor
Retrieves a single monitor by its ID.
- Read
List Monitors
Lists all monitors for the Webset.
- Read
Get Monitor
Gets a specific monitor.
- Write
Create a monitor
Creates a Monitor that runs an Exa search on a schedule and sends new results to your webhook. Each run searches recent content and drops results that match what earlier runs already returned, so your webhook receives only new developments.
- Write
Batch action on monitors
Deletes, pauses, or unpauses the monitors that match the filter. Deletion is permanent. dryrun defaults to true, so a request only previews the affected monitors unless you set it to false. Repeat the request until hasmore is false to process all matches.
- Write
Update a monitor
Updates an existing monitor. All fields are optional. For search, you can send a partial object containing only the fields you want to change. Set trigger to null to remove the schedule.
- Write
Trigger a monitor
Triggers a run immediately, regardless of the schedule. Works for monitors with status active or paused.
- Write
Create a Monitor
Creates a Monitor that searches for new Items for a Webset on a cron schedule in the given timezone.
- Write
Update Monitor
Updates a monitor configuration.
- Destructive
Delete a monitor
Deletes a monitor. This cannot be undone.
- Destructive
Delete Monitor
Deletes a monitor.
Runs
- Read
List runs
Lists all runs for a monitor with cursor-based pagination. Runs are returned in reverse chronological order.
- Read
Get a run
Retrieves a single run by its ID, including the full output if the run is completed.
Agent
- Read
List runs
List Agent runs for your team, ordered from newest to oldest.
- Read
Get a run
Retrieve a single Agent run by ID.
- Read
List run events
List stored events for an Agent run. Set Accept: text/event-stream to replay stored events as server-sent events. Use cursor for JSON pagination or Last-Event-ID for SSE replay.
- Write
Create a run
Create an asynchronous Agent run. By default, the API returns the run object immediately. Set Accept: text/event-stream to stream run lifecycle events until the run reaches a terminal status.
- Write
Stop a run
Complete a running Agent run early, returning the results gathered so far. You are billed for usage accrued before the stop. Currently supported only for ultra effort runs. If the run has already reached a terminal status, the API returns the existing run.
- Destructive
Delete a run
Delete a stored Agent run.
- Destructive
Cancel a run
Cancel a queued or running Agent run immediately without returning any results. You are billed for usage accrued before cancellation. If the run has already reached a terminal status, the API returns the existing run.
Batches
- Read
List batches
List batches for your team, ordered from newest to oldest.
- Read
Get a batch
Retrieve a single batch by ID.
- Write
Create a batch
Create a batch of requests to run asynchronously. Each request is dispatched to its target route and results are made available for download when the batch completes.
- Destructive
Delete a batch
Soft-delete a batch in a terminal status.
- Destructive
Cancel a batch
Request cancellation of a batch. The batch stops scheduling new requests and drains in-flight work before settling to cancelled. Cancelling a batch that is already cancelling or cancelled is idempotent and returns the batch unchanged.
Teams
- Read
Get team info
Returns information about the authenticated team, including current concurrency usage and limits.
Websets
- Read
List all Websets
Returns a list of Websets. You can paginate through the results using the cursor parameter. You can filter results using the search parameter to find Websets by ID, external ID, or title.
- Read
Get a Webset
Returns a Webset by id or externalId, including its status, searches, imports, enrichments, and monitors. Pass expand=items to include up to the first 100 items in the response.
- Write
Create a Webset
Creates a new Webset with optional search, import, and enrichment configurations. The Webset will automatically begin processing once created. You can specify an externalId to reference the Webset with your own identifiers for easier integration.
- Write
Update a Webset
Updates the title or metadata of a Webset. Searches, imports, and enrichments are managed through their own endpoints.
- Destructive
Delete a Webset
Deletes a Webset. Once deleted, the Webset and all its Items will no longer be available.
- Destructive
Cancel a running Webset
Cancels all operations being performed on a Webset. Any enrichment or search will be stopped and the Webset will be marked as idle.
Searches
- Read
Get a Search
Gets a Search by id
- Write
Create a Search
Creates a new Search for the Webset. The default behavior is to reuse the previous Search results and evaluate them against the new criteria.
- Destructive
Cancel a running Search
Cancels a currently running Search. You can cancel all searches at once by using the websets/:webset/cancel endpoint.
Enrichments
- Read
Get an Enrichment
Returns an Enrichment configured on a Webset, including its status, description, format, and options.
- Write
Create an Enrichment
Create an Enrichment for a Webset.
- Write
Update an Enrichment
Update an Enrichment configuration for a Webset.
- Destructive
Delete an Enrichment
When deleting an Enrichment, any running enrichments will be canceled and all existing enrichmentresult generated by this Enrichment will no longer be available.
- Destructive
Cancel a running Enrichment
All running enrichments will be canceled. You can not resume an Enrichment after it has been canceled.
Items
- Read
Get an Item
Returns a Webset Item.
- Read
List all Items for a Webset
Returns a list of Webset Items. You can paginate through the Items using the cursor parameter.
- Destructive
Delete an Item
Deletes an Item from the Webset. This will cancel any enrichment process for it.
Websets Preview
- Read
Preview a webset
Returns how a search query will be interpreted before you create a Webset, including the detected entity, generated criteria, and suggested enrichments.
Monitors Runs
- Read
List Monitor Runs
Lists all runs for the Monitor.
- Read
Get Monitor Run
Gets a specific monitor run.
Imports
- Read
List Imports
Lists all imports for the Webset.
- Read
Get Import
Gets a specific import.
- Write
Create an Import
Creates an Import for your own data. Upload the file to the returned uploadUrl before uploadValidUntil, 1 hour after creation. Use an Import to enrich its records, to search within them with scope, or to leave them out of searches with exclude.
- Write
Update Import
Updates a import configuration.
- Destructive
Delete Import
Deletes a import.
Webhooks
- Read
List webhooks
Returns the active Webhooks for your team. You can paginate through the results using the cursor parameter.
- Read
Get a Webhook
Returns a Webhook by id, including its status, subscribed events, target URL, and metadata. The signing secret is not returned.
- Write
Create a Webhook
Creates a Webhook that delivers the selected events to your URL as they occur. The response includes the signing secret used to verify deliveries; it is only returned on creation.
- Write
Update a Webhook
Updates the target URL, subscribed events, or metadata of a Webhook. Omitted fields are left unchanged.
- Destructive
Delete a Webhook
Deletes a Webhook. Its status becomes inactive, which stops future webhook deliveries to its URL.
Webhooks Attempts
- Read
List webhook attempts
List all attempts made by a Webhook ordered in descending order.
Events
- Read
List all Events
List all events that have occurred in the system. You can paginate through the results using the cursor parameter.
- Read
Get an Event
Get a single Event by id. You can subscribe to Events by creating a Webhook.
Team Management
- Read
List API keys
Returns the authenticated team's API keys. Pass apikeyid to return a single key.
- Read
Get API key
Retrieves details of a specific API key by its ID.
- Read
Get API key usage
Returns an API key's cost over a time period, in total and by price.
- Write
Create API key
Creates a new API key for the authenticated team. Optionally specify a name, rate limit, and budget for the API key.
- Destructive
Update API key
Updates an existing API key's name and/or rate limit. Only API keys belonging to the authenticated team can be updated.
- Destructive
Delete API key
Deletes an API key. Only API keys belonging to the authenticated team can be deleted.
No operations match.
See How connections work for access and permissions, or browse all integrations.