📄️ Authenticate
Endpoint
📄️ List all created flows
This endpoint provides an overview of all created flows. For each flow, it gives 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 templatename or templateid (from GET /templates). Parameters allow to control the flow execution (details about the parameters 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 status, 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 stop and abort a started flow).
📄️ Delete a flow
This endpoint deletes a specific flow. Important: a flow can only be deleted if it is in state created, completed, aborted, or failed. A flow that is still runing cannot 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. Primarily intended for debugging purposes.
📄️ Upload input file for a flow
This endpoint allows to add files (primarily images) to a created flow. The images are expected as MIME-Type + Base64 (e.g., 'data images 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 files. Additional data is optional and can be used to store user-specific information attached to the input file.
📄️ List all output files for a flow
This endpoint provides an overview of all output files. The output files are available as soon as the flow has finished/stopped. When calling this route on a still runing flow, no output files are listed. The individual output files need to be downloaded via the next route (GET /{'{'}flowid{'}'}/output/{'{'}fileid{'}'})
📄️ Get a specific input file for a flow
This endpoint allows to retrieve an input file of a specific flow. Primarily intended for debugging purposes.
📄️ Get a specific output file for a flow
This endpoint allows to download the generated output files of a flow. The reference {'{'}fileid{'}'} needed to download an output file is provided in the previous route (GET /{'{'}flowid{'}'}/output).
📄️ 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 excepts as input (input types), and what it will provide as output (output types).