Skip to content

Get Workflow Statuses

GET
/api/agent-communication/workflow-statuses

Retrieve all available workflow statuses and communication parameter enumerations.

Returns the complete taxonomy of valid values for workflow states, message types, priorities, protocols, and agent statuses. Essential for UI filters, validation, and building communication requests with valid parameters.

Returns:

  • workflow_statuses: Valid workflow state values
  • message_types: Valid message type values
  • message_priorities: Valid priority level values
  • communication_protocols: Valid protocol values
  • agent_statuses: Valid agent status values

Raises:

  • HTTPException 500: For unexpected errors during enumeration retrieval

Use Cases:

  • Populate dropdown filters in UI
  • Validate user input for communication requests
  • Build dynamic workflow and message forms
  • Understand system taxonomy and valid values

Example Response:

{
    "workflow_statuses": ["active", "inactive", "paused", "completed"],
    "message_types": ["direct", "broadcast"],
    "message_priorities": ["low", "normal", "high"],
    "communication_protocols": ["direct", "broadcast"],
    "agent_statuses": ["online", "offline", "busy", "idle"]
}

Successful Response

WorkflowStatusesResponse

Workflow statuses enumeration response model.

Provides enumeration values for message types, message priorities, and agent statuses used throughout the communication system. Used for frontend dropdown population and validation endpoint configuration.

Fields:

  • message_types: List of all MessageType enum values
  • message_priorities: List of all MessagePriority enum values
  • agent_statuses: List of all AgentStatus enum values

Usage: GET /api/agent-communication/workflow-statuses returns this response model.

JSON Example:

{
  "messageTypes": ["direct", "broadcast", "consultation", "handoff"],
  "messagePriorities": ["low", "normal", "high", "critical"],
  "agentStatuses": ["idle", "active", "busy", "error"]
}
object
messageTypes
required
Messagetypes

All MessageType values

Array<string>
messagePriorities
required
Messagepriorities

All MessagePriority values

Array<string>
agentStatuses
required
Agentstatuses

All AgentStatus values

Array<string>