v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
AI Routines

Trigger AI Routine

Run an existing routine immediately, in addition to its schedule — e.g. to get an off-cycle result or verify a routine produces the email you expect.

Executes once using the routine owner's permissions and delivers the AI response to every recipient configured on the routine. Returns as soon as the run has started; the result arrives asynchronously via the routine's normal email delivery.

If a run is already in progress, the endpoint returns 409 rather than starting a second one. Manual runs that hit broken configuration will return 400 but not pause the schedule.

post/v1/ai/routines/{routineId}/trigger

Path parameters

idstring uuid required

The UUID of the routine.

Query parameters

userIdstring uuid

Requires an Organization API key. Target user membership ID.

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"
}