DEV

ChatGPT

ChatGPT Connection

Put ChatGPT to Work with @Human Automations and @Human Agents

The ChatGPT Connection documents all Triggers, Actions and Query Operations available for creating automations via the ChatGPT API.

What can you do with the ChatGPT Connection?

  • Connect to the ChatGPT API in a few clicks

  • Use the related ChatGPT Operations (see below) in @Human Automations or @Human Agents

Trigger Operations

Chat Completion Created

Triggers on: chat_completions/chat.completion.created

Triggered when a new chat completion is created.

Response Completed

Triggers on: responses/response.completed

Triggered when a response is successfully completed.

Response Failed

Triggers on: responses/response.failed

Triggered when a response execution fails.

Embedding Created

Triggers on: embeddings/embedding.created

Triggered when a new text embedding is generated.

Image Generated

Triggers on: images/image.generated

Triggered when a new image is successfully generated.

Image Failed

Triggers on: images/image.failed

Triggered when image generation fails.

Audio Transcription Completed

Triggers on: audio_transcriptions/audio.transcription.completed

Triggered when an audio file transcription is finished.

Audio Speech Generated

Triggers on: audio_speech/audio.speech.generated

Triggered when text-to-speech audio is generated.

Model Created

Triggers on: models/model.created

Triggered when a new model becomes available.

Model Deleted

Triggers on: models/model.deleted

Triggered when a fine-tuned model is deleted.

Moderation Completed

Triggers on: moderations/moderation.completed

Triggered when a content moderation check is finished.

File Created

Triggers on: files/file.created

Triggered when a new file is uploaded or created.

File Deleted

Triggers on: files/file.deleted

Triggered when a file is permanently removed.

Fine-Tuning Job Created

Triggers on: fine_tuning_jobs/fine_tuning.job.created

Triggered when a new fine-tuning job is initiated.

Fine-Tuning Job Succeeded

Triggers on: fine_tuning_jobs/fine_tuning.job.succeeded

Triggered when a fine-tuning job completes successfully.

Fine-Tuning Job Failed

Triggers on: fine_tuning_jobs/fine_tuning.job.failed

Triggered when a fine-tuning job fails to complete.

Fine-Tuning Job Cancelled

Triggers on: fine_tuning_jobs/fine_tuning.job.cancelled

Triggered when a fine-tuning job is manually cancelled.

Batch Created

Triggers on: batches/batch.created

Triggered when a new processing batch is created.

Batch Completed

Triggers on: batches/batch.completed

Triggered when a batch processing job is finished.

Batch Failed

Triggers on: batches/batch.failed

Triggered when a batch processing job fails.

Batch Cancelled

Triggers on: batches/batch.cancelled

Triggered when a batch job is cancelled.

Batch Expired

Triggers on: batches/batch.expired

Triggered when a batch job expires before completion.

Assistant Created

Triggers on: assistants/assistant.created

Triggered when a new AI assistant is created.

Assistant Updated

Triggers on: assistants/assistant.updated

Triggered when an assistant's configuration is modified.

Assistant Deleted

Triggers on: assistants/assistant.deleted

Triggered when an assistant is deleted.

Thread Created

Triggers on: threads/thread.created

Triggered when a new conversation thread is created.

Thread Deleted

Triggers on: threads/thread.deleted

Triggered when a conversation thread is deleted.

Thread Message Created

Triggers on: thread_messages/thread.message.created

Triggered when a new message is added to a thread.

Thread Message Completed

Triggers on: thread_messages/thread.message.completed

Triggered when a thread message is fully generated.

Thread Message Deleted

Triggers on: thread_messages/thread.message.deleted

Triggered when a message is removed from a thread.

Thread Run Created

Triggers on: runs/thread.run.created

Triggered when a new run is started on a thread.

Thread Run Completed

Triggers on: runs/thread.run.completed

Triggered when a thread run finishes successfully.

Thread Run Failed

Triggers on: runs/thread.run.failed

Triggered when a thread run encounters an error.

Thread Run Requires Action

Triggers on: runs/thread.run.requires_action

Triggered when a thread run is waiting for user action or tool output.

Thread Run Cancelled

Triggers on: runs/thread.run.cancelled

Triggered when a thread run is cancelled.

Thread Run Expired

Triggers on: runs/thread.run.expired

Triggered when a thread run times out.

Vector Store Created

Triggers on: vector_stores/vector_store.created

Triggered when a new vector store is created.

Vector Store Completed

Triggers on: vector_stores/vector_store.completed

Triggered when a vector store is fully processed and ready.

Vector Store Deleted

Triggers on: vector_stores/vector_store.deleted

Triggered when a vector store is deleted.

Action Operations

Action: Analyze Text

Action: Analyze Images

Action: Create Embedding

Action: Create Transcription

Query Operations

Example link

Example link

Obtaining Access Credentials

To obtain a Personal Access Token (PAT) for OpenAI (system-to-system access via UI), follow these steps:

Prerequisites

  • An OpenAI account (sign up at https://platform.openai.com)

  • Access to the OpenAI API dashboard (requires an active subscription if using paid APIs)

Steps to Generate a PAT

  1. Log in to your OpenAI account at https://platform.openai.com.

  2. Navigate to the API keys section:

    • Click on the "API keys" button, under the Manage section.

  3. Create a new secret key:

    • Click "Create new secret key".

    • Provide a name (optional but recommended for tracking).

    • Select the required permissions - All.

  4. Copy the generated key:

    • The PAT will be displayed once—store it securely.

Configuring Webhooks

  1. Log in to your OpenAI account at https://platform.openai.com.

  2. Navigate to the Webhooks section:

    • Click on "Settings" or select your Project from the left sidebar.

    • Click on the "Webhooks" tab.

  3. Create a new webhook endpoint:

    • Click the "Create" button.

    • Provide your Endpoint URL (must be a public HTTPS URL).

    • Select the Events you want to subscribe to (e.g., batch.completed, response.completed).

  4. Copy the signing secret:

    • Once the webhook is created, copy the Signing Secret.

    • Use this secret to verify that incoming requests are sent from OpenAI.

Code (Apache v2.0): Service Connectivity and Metadata

Code (Apache v2.0): List of External Resources and Internal Mapping

Last updated