Get an AI Routine
Retrieve details for a specific AI Routine by ID, including its persisted condition query and the status of its most recent completed run.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The UUID of the routine.
Query Parameters
Organization API key required. Target user membership ID.
Response
Routine details
Branch of the shared model the prompt runs against, or null.
The delivery condition. Null for a routine that delivers on every scheduled run.
ISO 8601 timestamp when the routine was created.
Display-only notes about the routine, or null.
Single delivery destination for the routine — email or Slack. To send results to multiple destinations, create one routine per destination.
- Option 1
- Option 2
Whether the owner has paused the routine.
The unique identifier of the routine.
Most recent completed run, or null if the routine has never completed a run.
The shared model the prompt runs against.
Customer-visible name of the routine, used as the email subject.
Natural language prompt Omni runs on each scheduled run.
Number of distinct deliverable recipients after expanding user groups and removing duplicates.
Six-field cron expression (minute, hour, day-of-month, month, day-of-week, year; use ? for an unspecified day field).
Whether Omni disabled the routine because it could no longer run successfully or safely.
Reason Omni disabled the routine, or null.
IANA timezone identifier used to evaluate the schedule.
Topic scoping query generation, or null.
ISO 8601 timestamp when the routine was last updated.

