Sign in

v2

latestOpenAPI 3.1.02026-07-26143251806.6 KB
workflow

Get Agent

get/workflows/{workflow_id_or_name}

Path parameters

workflow_id_or_namestring required

The agent ID or name.

Query parameters

versioninteger

Specific version number to retrieve. Mutually exclusive with label.

labelstring

Release label name to retrieve (e.g. 'prod', 'staging'). Mutually exclusive with version.

Response

Agent retrieved successfully

successboolean required
workflow_idinteger required

Unique identifier for the agent

workflow_namestring required

Name of the agent

versioninteger required

Version number

workflow_version_idinteger required

Unique identifier for this version

commit_messagestring nullable

Commit message for this version

required_input_variablesobject nullable

Input variable names mapped to their types

release_labelsstring[]

Release labels attached to this version

created_atstring nullable

ISO 8601 timestamp of when this version was created

Example response

{
  "success": true
}