📄️ Authentication
Prerequisites
📄️ List all created flows
Get an overview of all created flows. For each flow, the result provides details about the used template, the configured parameters, the status, and current progress. The sortby parameter allows to sort the flows by one of the fields: status, progress, createdat, startedat, finishedat. The filter_by parameter allows to filter the fields returned in each flow summary. If not provided, all fields are returned.
📄️ Create a new flow
This endpoint allows to create new flows. The template should be a valid template id or name (from GET /templates). Parameters allow to customize the flow execution (details about the available parameters of a template are provided in GET /templates as well). Additional data is optional and can be used to store user-specific information. Inputs are optional and allow to directly upload input files (e.g., images) to the flow. Important: when inputs are provided the flow will start automatically.
📄️ List flow details and current state
This endpoint provides details about a specific flow. It gives details about the used template, the configured parameters, the state, and current progress.
📄️ Start or abort a flow
This endpoint allows to control the flow execution. Allowed actions are 'start' (to start a flow) or 'abort' (to abort a started flow).Action 'start' can only be applied to a created flow that has not been started yet. Action 'abort' can only be applied to a starting or running flow.
📄️ Delete a flow
This endpoint deletes a specific flow. Important created, completed, aborted, or failed. A flow that is still starting, running or aborting can not be deleted.
📄️ List all uploaded input files for a flow
This endpoint allows to get an overview of all uploaded input files for a specific flow.
📄️ Upload input asset for a flow
This endpoint allows to add input assets to a created flow. The assets are expected as data with the structure MIME-Type + Base64 (e.g., 'data assets can only be added to a created flow that has not been started yet. After a flow has been started, it is not possible to add more input assets. Additional data is optional and can be used to store user-specific information attached to the input asset (and copied to the output asset).
📄️ List all output assets for a flow
This endpoint provides an overview of all output assets. The output assets are available as soon as the flow has completed / aborted / failed. When calling this route on a created or still running / aborting flow, an error is returned. The individual output assets can be downloaded via the next route (GET /{'{'}flowid{'}'}/output/{'{'}assetid{'}'})
📄️ Get a specific input asset for a flow
This endpoint allows to retrieve an input asset of a specific flow.
📄️ Get a specific output asset for a flow
This endpoint allows to download the generated output assets of a flow. The reference {'{'}assetid{'}'} needed to download an output asset is provided in the previous route (GET /{'{'}flowid{'}'}/outputs).
📄️ List all available templates
This endpoint returns a list of all available templates. Templates are used to create new flows. Each template includes details that help understanding what the created flow is used for (description), how it can be configured (parameters), what it expects as input (input types), and what it will provide as output (output types).
📄️ Get a specific template by ID or name
This endpoint returns the details of a specific template identified by its ID or name. Templates are used to create new flows. Each template includes details that help understanding what the created flow is used for (description), how it can be configured (parameters), what it expects as input (input types), and what it will provide as output (output types).