OMomni
AI Routines

Trigger AI Routine

Changed on

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. A conditional routine evaluates its delivery condition first, so the run may complete without delivering.

Returns as soon as the run has started; the result is delivered asynchronously.

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/routines/{routineId}/trigger
  • Auth
    HTTP bearer

Path parameters

routineIdstring uuid required

The UUID of the routine.

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

The run has started. For a conditional routine this is the condition evaluation, which delivers only if the condition is met.

idstring uuid required

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

Example response

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

Changes

  • 43290040f88fRevision changes
    • breaking

      added the new path request parameter routineId

    • warning

      deleted the path request parameter id

    • info

      api operation id triggerAIRoutine removed and replaced with routineTrigger