Trigger workspace agent

triggerChatGPTWorkspaceAgent queues a published ChatGPT Workspace Agent through its API channel.

automations/trigger-chatgpt-agent.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { triggerChatGPTWorkspaceAgent } from "automate.ax/chatgpt"

export default automation("Start ChatGPT agent", () => {
  const request = onHttpRequest({ scope: "automation" })
  const run = triggerChatGPTWorkspaceAgent({
    apiTriggerId: "agtch_engineering_123",
    conversationKey: request.headers["x-thread-id"],
    idempotencyKey: request.headers["x-event-id"],
    input: "Review the latest engineering request and implement it.",
  })

  run.runId
  run.conversationUrl
})

apiTriggerId is the stable agtch_ identifier shown for the agent’s published API channel. input is the message sent to the agent. Optional conversationKey continues the same agent conversation across related events. Optional idempotencyKey prevents a retry of the same event from adding a second trigger. Optional second argument { account } defaults to the project binding. The action returns the apirun_ run ID and ChatGPT conversation URL after ChatGPT accepts the run. Use getChatGPTWorkspaceAgentRun to poll its status. ChatGPT does not currently expose the agent’s response through this API. Connect ChatGPT with a Workspace Agent access token created in ChatGPT workspace settings > Access tokens with the Workspace Agents scope. A workspace administrator must first enable Workspace agents and personal access tokens.

⌘I

Get started

Guides

Concepts

Management API

Reference

Trigger workspace agent