v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

AI Routines

Run a routine now

Run a routine immediately, in addition to its schedule. The run executes once using the routine owner's permissions and delivers the AI response to every configured recipient — it is not a private preview. Because runs execute as the owner, the owner's per-connector AI toggles (set in the chat + menu) govern which integration tools the agent may use. Returns once the run has started; the result is delivered asynchronously. Organization API keys can pass ?userId=<membershipId> to act on behalf of a specific organization member.

post/api/v1/ai/routines/{id}/trigger

Path parameters

idstring uuid required

The UUID of the routine.

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Response

The run has started.

idstring uuid required

The ID of the run (scheduled job) that was started.

Example response

{
  "id": "990e8400-e29b-41d4-a716-446655440004"
}