Routines

Queue an asynchronous routine dispatch

POST /routines/{routine_name}:dispatch_async

Queues an asynchronous dispatch for the specified routine.

Header parameters

Foundry-Features enum

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

Routines=V2Preview

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.

Request Body

Content-Type: application/json

payload invoke_agent_responses_api | invoke_agent_invocations_api

Base model for a manual dispatch payload.

One of the following:

invoke_agent_responses_api InvokeAgentResponsesApiDispatchPayload

A manual payload used to test a responses API routine dispatch.

type enum required

The manual dispatch payload type.

invoke_agent_responses_api

input InvokeAgentResponsesApiDispatchPayload required

The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null.

invoke_agent_invocations_api InvokeAgentInvocationsApiDispatchPayload

A manual payload used to test an invocations API routine dispatch.

type enum required

The manual dispatch payload type.

invoke_agent_invocations_api

input InvokeAgentInvocationsApiDispatchPayload required

The JSON value sent as the complete downstream invocations input. The value is passed through as-is and can be an object, string, number, boolean, array, or null.

Responses

The request has succeeded.

Body

Content-Type: application/json

dispatch_id string

The dispatch identifier created for the routine dispatch.

action_correlation_id string

A downstream action correlation identifier, when available.

task_id string

A workspace task identifier created for the dispatch, when available.