Routines
Get a routine
Retrieves the specified routine and its current configuration.
Header parameters
Foundry-Features
enum
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
Path parameters
routine_name
string
required
The unique name of the routine.
Query parameters
api-version
string
required
The API version to use for this operation.
Responses
The request has succeeded.
Body
name
string
The routine name.
description
string
A human-readable description of the routine.
enabled
boolean
required
Whether the routine is enabled.
triggers
object
The triggers configured for the routine.
[key: string]
schedule | timer | github_issue | custom
Base model for a routine trigger.
schedule
ScheduleRoutineTrigger
A recurring cron-based routine trigger.
type
enum
required
The trigger type.
cron_expression
string
required
A 5-field cron expression. The service enforces a minimum interval of five minutes by default.
time_zone
string
required
An IANA or Windows time zone identifier for the schedule.
timer
TimerRoutineTrigger
A one-shot timer routine trigger.
type
enum
required
The trigger type.
github_issue
GitHubIssueRoutineTrigger
A GitHub issue routine trigger.
type
enum
required
The trigger type.
connection_id
string
required
The workspace connection identifier that resolves the GitHub configuration for the trigger.
owner
string
required
The GitHub owner or organization that scopes which issues can fire the trigger.
repository
string
required
The GitHub repository filter that scopes which issues can fire the trigger.
issue_event
string | enum
required
Known GitHub issue events that can fire a routine.
enum
custom
CustomRoutineTrigger
A custom event routine trigger.
type
enum
required
The trigger type.
provider
string
required
The external provider that emits the custom event.
event_name
string
The provider-specific event name that fires the routine.
parameters
object
required
Provider-specific trigger parameters.
action
invoke_agent_responses_api | invoke_agent_invocations_api
Base model for a routine action.
invoke_agent_responses_api
InvokeAgentResponsesApiRoutineAction
Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.
type
enum
required
The action type.
agent_name
string
The project-scoped agent name for routine dispatch.
agent_endpoint_id
string
Legacy endpoint-scoped agent identifier for routine dispatch.
input
InvokeAgentResponsesApiRoutineAction
Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied.
conversation
string
An optional existing conversation identifier to continue during the downstream dispatch.
invoke_agent_invocations_api
InvokeAgentInvocationsApiRoutineAction
Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.
type
enum
required
The action type.
agent_name
string
The project-scoped agent name for routine dispatch.
agent_endpoint_id
string
Legacy endpoint-scoped agent identifier for routine dispatch.
input
InvokeAgentInvocationsApiRoutineAction
Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied.
session_id
string
An optional existing hosted-agent session identifier to continue during the downstream dispatch.
Request
GET /routines/{routine_name} HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json