Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encord.com/llms.txt

Use this file to discover all available pages before exploring further.

​
WorkflowAction Objects

class WorkflowAction(str, Enum)
Actions that can be applied to a workflow stage for a task. Values: REOPEN: Reopen a task at a given stage. COMPLETE: Mark a task as completed at a given stage.

​
WorkflowStageType Objects

class WorkflowStageType(str, Enum)
Type of a workflow stage in a project workflow. Values: ANNOTATION: Annotation stage where labelers create or edit labels. REVIEW: Review stage where labels are reviewed and approved/rejected. USER_ROUTER: Router stage that routes tasks based on user assignment rules. PERCENTAGE_ROUTER: Router stage that routes tasks based on percentage splits. CONSENSUS_ANNOTATION: Annotation stage with consensus logic applied across annotators. CONSENSUS_REVIEW: Review stage with consensus logic applied across reviewers. DONE: Terminal stage indicating that workflow processing is complete. AGENT: Agent stage where tasks are handled by an automated agent.

​
LabelWorkflowGraphNode Objects

class LabelWorkflowGraphNode()
This class only required to indicate correct request type to basic querier, don’t use this anywhere else.

​
LabelWorkflowGraphNodePayload Objects

class LabelWorkflowGraphNodePayload(BaseDTO)
Payload describing an action to perform on a label workflow node. Arguments:
  • action - Workflow action to apply to the node (for example, reopen or complete).

​
BaseWorkflowNode Objects

class BaseWorkflowNode(BaseDTO)
Base class for workflow nodes in a project workflow graph. Arguments:
  • stage_type - Type of the workflow stage (annotation, review, router, etc.).
  • uuid - UUID of the workflow stage.
  • title - Human-readable title of the stage.

​
WorkflowNode Objects

class WorkflowNode(BaseWorkflowNode)
Standard workflow node. Represents all workflow stages except agent stages. Agent stages are represented by WorkflowAgentNode instead and are validated separately.

​
AgentNodePathway Objects

class AgentNodePathway(BaseDTO)
Outgoing pathway from an agent workflow node. Arguments:
  • uuid - UUID of the pathway itself.
  • title - Human-readable title or label for the pathway.
  • destination_uuid - UUID of the destination workflow stage that this pathway leads to.

​
WorkflowAgentNode Objects

class WorkflowAgentNode(BaseWorkflowNode)
Workflow node representing an agent stage. Agent stages route tasks automatically based on agent logic and can have multiple outgoing pathways defined by AgentNodePathway objects.

​
WorkflowDTO Objects

class WorkflowDTO(BaseDTO)
Full workflow definition for a project. Arguments:
  • stages - List of workflow stages in the project workflow graph. This can include both standard workflow nodes and agent nodes.