ASasteroid
Workflows

Execute workflow

Start an execution of the workflow's published version, of the version given in the request, or of the editable head when head is true.

post/agents/v2/workflows/{workflowId}/execute

Request

  • Base URL
    https://odyssey.asteroid.ai
  • URL
    https://odyssey.asteroid.ai/agents/v2/workflows/{workflowId}/execute
  • Auth
    API key in header X-Api-Key

Path parameters

workflowIdstring uuid required

Request body

agentProfileIdstring uuid
agentProfilePoolIdstring uuid
dynamicDataobject

Deprecated: Use 'inputs' instead. Inputs to be merged into the placeholders defined in prompts

headboolean

Run the editable head instead of the published version. Cannot be combined with version.

inputsobject

Inputs to be merged into the placeholders defined in prompts

metadataobject

Optional metadata key-value pairs (string keys and string values) for organizing and filtering executions

onCapacityLimit'reject' | 'queue'

Behaviour when the organisation or profile pool has no capacity for the execution

profileGroupIdstring uuid
profileIdstring uuid
versioninteger

The version of the workflow to execute. If neither version nor head is provided, the published version is used.

Response

The request has been accepted for processing, but processing has not yet completed.

executionIdstring uuid required
status'queued' | 'starting' | 'running' | 'paused' | 'awaiting_confirmation' | 'completed' | 'cancelled' | 'failed' | 'paused_by_agent'

Changes

No recorded changes to this operation across all 1 revision of this API.