Get Contents of Documents with Exa (Formerly Metaphor) API on New Worksheet (Instant) from Google Sheets API

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

Trigger workflow on

New Worksheet (Instant) from the Google Sheets API

Next, do this

Get Contents of Documents 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#

This integration creates a workflow with a Google Sheets trigger and Exa (Formerly Metaphor) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Worksheet (Instant) trigger
1. Connect your Google Sheets account
2. Configure Push notification renewal schedule
3. Select a Spreadsheet
Configure the Get Contents of Documents action
1. Connect your Exa (Formerly Metaphor) account
2. Optional- Configure Ids
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Worksheet (Instant) on Google Sheets

Description:Emit new event each time a new worksheet is created in a spreadsheet.

Version:0.1.8

Key:google_sheets-new-worksheet

View on GitHub

Google Sheets Overview#

The Google Sheets API allows for the creation, reading, updating, and deletion of data within Google Sheets, enabling a robust platform for spreadsheet management and data manipulation. Through Pipedream, you can craft serverless workflows that respond to various triggers, such as webhook events, emails, or scheduled times, to interact with Google Sheets. This synergy can automate reporting, synchronize data across applications, manage inventory, track leads in a CRM, or even conduct survey analysis by updating and retrieving sheet data on the fly.

Trigger Code#

import httpBase from "../common/http-based/sheet.mjs";
import newWorksheet from "../common/new-worksheet.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...httpBase,
  ...newWorksheet,
  key: "google_sheets-new-worksheet",
  type: "source",
  name: "New Worksheet (Instant)",
  description: "Emit new event each time a new worksheet is created in a spreadsheet.",
  version: "0.1.8",
  dedupe: "unique",
  hooks: {
    ...httpBase.hooks,
    ...newWorksheet.hooks,
  },
  props: {
    ...httpBase.props,
    ...newWorksheet.props,
  },
  methods: {
    ...httpBase.methods,
    ...newWorksheet.methods,
  },
  sampleEmit,
};

Trigger 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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Drive API requires occasionally renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.
Spreadsheet	`sheetID`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Google Sheets uses OAuth authentication. When you connect your Google Sheets account, Pipedream will open a popup window where you can sign into Google Sheets and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Sheets API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drive

About Google Sheets#

Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.

Action#

Get Contents of Documents on Exa (Formerly Metaphor)

Description:Retrieve contents of documents based on a list of document IDs. [See the documentation](https://docs.metaphor.systems/reference/contents). 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.

Version:0.0.1

Key:metaphor-get-documents-content

View on GitHub

Exa (Formerly Metaphor) Overview#

The Exa (Formerly Metaphor) API enables you to enrich your applications with machine learning-powered insights and data processing capabilities. With Exa, you can perform advanced data analysis, extract meaningful patterns, and automate decision-making processes within your projects. By integrating this API with Pipedream, you can create seamless workflows that leverage these intelligent features alongside other services to streamline your operations, enhance data intelligence, and drive innovation.

Action Code#

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

export default {
  key: "metaphor-get-documents-content",
  name: "Get Contents of Documents",
  version: "0.0.1",
  description: "Retrieve contents of documents based on a list of document IDs. [See the documentation](https://docs.metaphor.systems/reference/contents). 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.",
  type: "action",
  props: {
    metaphor,
    ids: {
      type: "string[]",
      label: "Ids",
      description: "An array of document IDs obtained from either `/search` or `/findSimilar` endpoints.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      metaphor,
      ids,
    } = this;

    const response = await metaphor.getContents({
      $,
      params: {
        ids,
      },
    });

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

Action Configuration#

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

Label	Prop	Type	Description
Exa (Formerly Metaphor)	`metaphor`	`app`	This component uses the Exa (Formerly Metaphor) app.
Ids	`ids`	`string[]`	An array of document IDs obtained from either `/search` or `/findSimilar` endpoints.

Action 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.