Cancel Run (Assistants) with OpenAI (ChatGPT) API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Cancel Run (Assistants) with the OpenAI (ChatGPT) 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 Cancel Run (Assistants) with the OpenAI (ChatGPT) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Cancel Run (Assistants) action
1. Connect your OpenAI (ChatGPT) account
2. Configure Thread ID
3. Select a Run ID
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#

Cancel Run (Assistants) with OpenAI (ChatGPT) API on New Dismissal from Convenia API

Convenia + OpenAI (ChatGPT)

Try it

Cancel Run with OpenAI (ChatGPT) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + OpenAI (ChatGPT)

Try it

Cancel Run with OpenAI (ChatGPT) API on New Submission from Typeform API

Typeform + OpenAI (ChatGPT)

Try it

Cancel Run with OpenAI (ChatGPT) API on Custom Events from Zoom API

Zoom + OpenAI (ChatGPT)

Try it

Cancel Run with OpenAI (ChatGPT) API on New Submission (Instant) from Jotform API

Jotform + OpenAI (ChatGPT)

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.

Cancel Run (Assistants) on OpenAI (ChatGPT)

Description:Cancels a run that is in progress. [See the documentation](https://platform.openai.com/docs/api-reference/runs/cancelRun)

Version:0.0.11

Key:openai-cancel-run

View on GitHub

Code#

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

export default {
  key: "openai-cancel-run",
  name: "Cancel Run (Assistants)",
  description: "Cancels a run that is in progress. [See the documentation](https://platform.openai.com/docs/api-reference/runs/cancelRun)",
  version: "0.0.11",
  type: "action",
  props: {
    openai,
    threadId: {
      propDefinition: [
        openai,
        "threadId",
      ],
    },
    runId: {
      propDefinition: [
        openai,
        "runId",
        ({ threadId }) => ({
          threadId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const response = await this.openai.cancelRun({
      $,
      threadId: this.threadId,
      runId: this.runId,
    });

    $.export("$summary", `Successfully cancelled run ${this.runId} in thread ${this.threadId}`);
    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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs
Run ID	`runId`	`string`	Select a value from the drop down menu.