Add Keyword with Raven Tools API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Raven Tools, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Add Keyword with the Raven Tools 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 OpenAI (ChatGPT) trigger and Raven Tools action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Batch Completed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
Configure the Add Keyword action
1. Connect your Raven Tools account
2. Select a Domain
3. Configure Keyword
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 Batch Completed on OpenAI (ChatGPT)

Description:Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)

Version:0.0.5

Key:openai-new-batch-completed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-batch-completed",
  name: "New Batch Completed",
  description: "Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastCompleted() {
      return this.db.get("lastCompleted") || 0;
    },
    _setLastCompleted(lastCompleted) {
      this.db.set("lastCompleted", lastCompleted);
    },
    getMeta(batch) {
      return {
        id: batch.id,
        summary: `Batch Completed with ID ${batch.id}`,
        ts: batch.completed_at * 1000,
      };
    },
    async getAndProcessItems(max) {
      const lastCompleted = this._getLastCompleted();
      let maxCompleted = lastCompleted;
      const results = this.openai.paginate({
        resourceFn: this.openai.listBatches,
        max,
      });
      const batches = [];
      for await (const batch of results) {
        if (batch.completed_at && batch.completed_at > lastCompleted) {
          batches.push(batch);
          maxCompleted = Math.max(batch.completed_at, maxCompleted);
        }
      }
      this._setLastCompleted(maxCompleted);
      batches.reverse().forEach((item) => this.$emit(item, this.getMeta(item)));
    },
  },
  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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

Add Keyword on Raven Tools

Description:Add a keyword to a domain [See docs here](https://api.raventools.com/docs/#add_keyword)

Version:0.0.1

Key:raven_tools-add-keyword

View on GitHub

Raven Tools Overview#

Raven Tools is a comprehensive suite of SEO tools that helps marketers to conduct audits, track search engine rankings, and analyze competitors' strategies. With the Raven Tools API, one can programmatically access this wealth of SEO data and generate reports, manage link building campaigns, and monitor keyword rankings. Leveraging the Pipedream platform, you can create automated workflows that react to various triggers and connect Raven Tools with other services to streamline SEO processes, enhance data analysis, and improve decision-making.

Action Code#

import app from "../../app/raven_tools.app.mjs";
import { defineAction } from "@pipedream/types";
const DOCS = "https://api.raventools.com/docs/#add_keyword";
export default defineAction({
    name: "Add Keyword",
    description: `Add a keyword to a domain [See docs here](${DOCS})`,
    key: "raven_tools-add-keyword",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        domain: {
            propDefinition: [
                app,
                "domain",
            ],
            description: "The domain to add the keyword to.",
        },
        keyword: {
            label: "Keyword",
            description: "The keyword to add.",
            type: "string",
        },
    },
    async run({ $ }) {
        const { domain, keyword, } = this;
        const params = {
            $,
            params: {
                domain,
                keyword,
            },
        };
        const data = await this.app.addKeyword(params);
        if (data?.response !== "success") {
            throw new Error(`Something went wrong. RavenTools response: ${data && JSON.stringify(data)}`);
        }
        $.export("$summary", `Successfully added keyword "${keyword}"`);
        return data;
    },
});

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
Raven Tools	`app`	`app`	This component uses the Raven Tools app.
Domain	`domain`	`string`	Select a value from the drop down menu.
Keyword	`keyword`	`string`	The keyword to add.

Action Authentication#

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

In order to use Raven's API, you must create an API key for each Profile that you want to use with the API. This key is generated through the following steps:

Navigate to Preferences > Profile Manager.
Click the name of the Profile that you would like to generate an API key for.
On this page, click the Get New API Key button.

Add Keyword with Raven Tools API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Raven Tools, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular