Search with Exa (Formerly Metaphor) API

Pipedream makes it easy to connect APIs for Exa (Formerly Metaphor) and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search with the Exa (Formerly Metaphor) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Search with the Exa (Formerly Metaphor) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search action
1. Connect your Exa (Formerly Metaphor) account
2. Configure Query
3. Optional- Configure Number Of Results
4. Optional- Configure Include Domains
5. Optional- Configure Exclude Domains
6. Optional- Configure Start Crawl Date
7. Optional- Configure End Crawl Date
8. Optional- Configure Start Published Date
9. Optional- Configure End Published Date
10. Configure Use Autoprompt
11. Optional- Select a Type
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search with Exa (Formerly Metaphor) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Exa (Formerly Metaphor)

Try it

Search with Exa (Formerly Metaphor) API on New Submission from Typeform API

Typeform + Exa (Formerly Metaphor)

Try it

Search with Metaphor API on Custom Events from Zoom API

Zoom + Exa (Formerly Metaphor)

Try it

Search with Exa (Formerly Metaphor) API on New Submission (Instant) from Jotform API

Jotform + Exa (Formerly Metaphor)

Try it

Search with Exa (Formerly Metaphor) API on New Scheduled Tasks from Pipedream API

Pipedream + Exa (Formerly Metaphor)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search on Exa (Formerly Metaphor)

Description:Perform a search with a Metaphor prompt-engineered query and retrieve a list of relevant results. [See the documentation](https://docs.metaphor.systems/reference/search)

Version:0.0.1

Key:metaphor-search

View on GitHub

Code#

import metaphor from "../../metaphor.app.mjs";

export default {
  key: "metaphor-search",
  name: "Search",
  version: "0.0.1",
  description: "Perform a search with a Metaphor prompt-engineered query and retrieve a list of relevant results. [See the documentation](https://docs.metaphor.systems/reference/search)",
  type: "action",
  props: {
    metaphor,
    query: {
      propDefinition: [
        metaphor,
        "query",
      ],
    },
    numResults: {
      propDefinition: [
        metaphor,
        "numResults",
      ],
      optional: true,
    },
    includeDomains: {
      propDefinition: [
        metaphor,
        "includeDomains",
      ],
      optional: true,
    },
    excludeDomains: {
      propDefinition: [
        metaphor,
        "excludeDomains",
      ],
      optional: true,
    },
    startCrawlDate: {
      propDefinition: [
        metaphor,
        "startCrawlDate",
      ],
      optional: true,
    },
    endCrawlDate: {
      propDefinition: [
        metaphor,
        "endCrawlDate",
      ],
      optional: true,
    },
    startPublishedDate: {
      propDefinition: [
        metaphor,
        "startPublishedDate",
      ],
      optional: true,
    },
    endPublishedDate: {
      propDefinition: [
        metaphor,
        "endPublishedDate",
      ],
      optional: true,
    },
    useAutoprompt: {
      propDefinition: [
        metaphor,
        "useAutoprompt",
      ],
    },
    type: {
      propDefinition: [
        metaphor,
        "type",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      metaphor,
      ...data
    } = this;

    const response = await metaphor.search({
      $,
      data,
    });

    $.export("$summary", `${response.results.length} result${response.results.length > 1
      ? "s were"
      : " was"} successfully fetched!`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Exa (Formerly Metaphor)	`metaphor`	`app`	This component uses the Exa (Formerly Metaphor) app.
Query	`query`	`string`	The query string. On the web, people often recommend content - it's vital that the query takes the form of a declarative suggestion, where a high quality search result link would follow.
Number Of Results	`numResults`	`integer`	Number of search results to return. Default 10. Up to 30 for basic plans. Up to thousands for custom plans.
Include Domains	`includeDomains`	`string[]`	List of domains to include in the search. If specified, results will only come from these domains. Only one of includeDomains and excludeDomains should be specified.
Exclude Domains	`excludeDomains`	`string[]`	List of domains to exclude in the search. If specified, results will only come from these domains. Only one of includeDomains and excludeDomains should be specified.
Start Crawl Date	`startCrawlDate`	`string`	"Crawl date" refers to the date that Metaphor discovered a link, which is more granular and can be more useful than published date. If startCrawlDate is specified, results will only include links that were crawled after startCrawlDate. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
End Crawl Date	`endCrawlDate`	`string`	"Crawl date" refers to the date that Metaphor discovered a link, which is more granular and can be more useful than published date. If endCrawlDate is specified, results will only include links that were crawled before endCrawlDate. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
Start Published Date	`startPublishedDate`	`string`	If specified, only links with a published date after startPublishedDate will be returned. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Note that for some links, we have no published date, and these links will be excluded from the results if startPublishedDate is specified.
End Published Date	`endPublishedDate`	`string`	If specified, only links with a published date before endPublishedDate will be returned. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Note that for some links, we have no published date, and these links will be excluded from the results if endPublishedDate is specified.
Use Autoprompt	`useAutoprompt`	`boolean`	The url for which you would like to find similar links.
Type	`type`	`string`	Select a value from the drop down menu:`keywordneural`

Authentication#

Exa (Formerly Metaphor) uses API keys for authentication. When you connect your Exa (Formerly Metaphor) account, Pipedream securely stores the keys so you can easily authenticate to Exa (Formerly Metaphor) APIs in both code and no-code steps.

Navigate to the overview tab to find your API key, and enter it below.

About Exa (Formerly Metaphor)#

Search Rebuilt for AI. The Exa API retrieves the best content on the web using embeddings-based search.

More Ways to Use Exa (Formerly Metaphor)#

Actions#

Find Similar Links with the Exa (Formerly Metaphor) API

Find similar links to the link provided. See the documentation](https://docs.metaphor.systems/reference/findsimilar)

Try it

Get Contents of Documents with the Exa (Formerly Metaphor) API

Retrieve contents of documents based on a list of document IDs. See the documentation. It is used to instantly get content for documents, given the IDs of the documents. We currently support extracts - the first 1000 tokens (~750 words) of parsed HTML for a site. Note that each piece of content retrieved costs 1 request. Also note that instant is a little bit of a lie if you are using keyword search, in which case contents might take a few seconds to retrieve.

Try it