Package ai.extend.resources.workflows

Class WorkflowsClient

java.lang.Object

ai.extend.resources.workflows.WorkflowsClient

public class WorkflowsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
WorkflowsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Workflow	create(WorkflowsCreateRequest request)	Create a new workflow.
Workflow	create(WorkflowsCreateRequest request, RequestOptions requestOptions)	Create a new workflow.
WorkflowsListResponse	list()	List all workflows.
WorkflowsListResponse	list(RequestOptions requestOptions)	List all workflows.
WorkflowsListResponse	list(WorkflowsListRequest request)	List all workflows.
WorkflowsListResponse	list(WorkflowsListRequest request, RequestOptions requestOptions)	List all workflows.
Workflow	retrieve(java.lang.String id)	Get details of a workflow, including its draft version and steps.
Workflow	retrieve(java.lang.String id, RequestOptions requestOptions)	Get details of a workflow, including its draft version and steps.
Workflow	update(java.lang.String id)	Update a workflow's draft.
Workflow	update(java.lang.String id, RequestOptions requestOptions)	Update a workflow's draft.
Workflow	update(java.lang.String id, WorkflowsUpdateRequest request)	Update a workflow's draft.
Workflow	update(java.lang.String id, WorkflowsUpdateRequest request, RequestOptions requestOptions)	Update a workflow's draft.
RawWorkflowsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

WorkflowsClient

public WorkflowsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawWorkflowsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public WorkflowsListResponse list()

List all workflows. Returns a paginated list of workflow summaries.

list

public WorkflowsListResponse list(RequestOptions requestOptions)

List all workflows. Returns a paginated list of workflow summaries.

list

public WorkflowsListResponse list(WorkflowsListRequest request)

List all workflows. Returns a paginated list of workflow summaries.

list

public WorkflowsListResponse list(WorkflowsListRequest request,
                                  RequestOptions requestOptions)

List all workflows. Returns a paginated list of workflow summaries.

create

public Workflow create(WorkflowsCreateRequest request)

Create a new workflow. Optionally provide steps to define the workflow's step graph.

When steps is omitted, the workflow is created with default steps (TRIGGER → PARSE). When steps is provided, the step graph is validated and the draft version is populated with the given steps.

Note: The default steps may change in the future. If your integration depends on a specific step graph, provide steps explicitly.

create

public Workflow create(WorkflowsCreateRequest request,
                       RequestOptions requestOptions)

Create a new workflow. Optionally provide steps to define the workflow's step graph.

When steps is omitted, the workflow is created with default steps (TRIGGER → PARSE). When steps is provided, the step graph is validated and the draft version is populated with the given steps.

Note: The default steps may change in the future. If your integration depends on a specific step graph, provide steps explicitly.

retrieve

public Workflow retrieve(java.lang.String id)

Get details of a workflow, including its draft version and steps.

retrieve

public Workflow retrieve(java.lang.String id,
                         RequestOptions requestOptions)

Get details of a workflow, including its draft version and steps.

update

public Workflow update(java.lang.String id)

Update a workflow's draft. You can update the name, the steps, or both.

When steps is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.

update

public Workflow update(java.lang.String id,
                       RequestOptions requestOptions)

Update a workflow's draft. You can update the name, the steps, or both.

When steps is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.

update

public Workflow update(java.lang.String id,
                       WorkflowsUpdateRequest request)

Update a workflow's draft. You can update the name, the steps, or both.

When steps is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.

update

public Workflow update(java.lang.String id,
                       WorkflowsUpdateRequest request,
                       RequestOptions requestOptions)

Update a workflow's draft. You can update the name, the steps, or both.

When steps is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.