Workflows

Workflow management and execution endpoints

gethttps://app.meingpt.com/api/workflows/v1/user-workflows

Get user workflows

Retrieves all workflows accessible to the authenticated user

🔒 ApiKeyAuth

Parameter

ParameterInTypBeschreibung
Authorization*headerstringAPI key for authentication. Use 'Bearer <your-api-key>' format.

Responses

200Successfully retrieved workflows

SuccessResponse & object

500Internal server error
FeldTypBeschreibung
statusstring
messagestring
gethttps://app.meingpt.com/api/workflows/v1/workflow-inputs/{workflowId}

Get workflow input variables

Retrieves the input variables/parameters required to run a specific workflow

🔒 ApiKeyAuth

Parameter

ParameterInTypBeschreibung
Authorization*headerstringAPI key for authentication. Use 'Bearer <your-api-key>' format.
workflowId*pathstringThe workflow ID

Responses

200Successfully retrieved workflow inputs

SuccessResponse & object

404Workflow not found
FeldTypBeschreibung
statusstring
messagestring
500Internal server error
FeldTypBeschreibung
statusstring
messagestring
posthttps://app.meingpt.com/api/workflows/v1/{workflowId}/run

Run a workflow

Executes a workflow with the provided input parameters

🔒 ApiKeyAuth

Parameter

ParameterInTypBeschreibung
Authorization*headerstringAPI key for authentication. Use 'Bearer <your-api-key>' format.
workflowId*pathstringThe workflow ID to execute

Request Body · application/json

FeldTypBeschreibung
input*objectInput parameters for the workflow execution

Responses

200Workflow executed successfully

SuccessResponse & object

400Bad request - invalid input
FeldTypBeschreibung
statusstring
messagestring
403Forbidden - workflow API not enabled for organization
FeldTypBeschreibung
statusstring
messagestring
404Workflow not found
FeldTypBeschreibung
statusstring
messagestring
500Internal server error
FeldTypBeschreibung
statusstring
messagestring

Timeouts for Synchronous API Calls

A workflow run via the API is synchronous — there is no separate status or polling endpoint. The request stays open until the workflow finishes or an infrastructure timeout occurs, typically around five minutes. Plan workflows meant for API calls to finish well within that window, or trigger them asynchronously via an external automation (e.g. Make) that checks completion separately.

Uploading additional documents per run

You can attach additional documents to a workflow run (multipart/form-data request, max. 10 files, max. 150 MB per file — see the API reference for the value actually enforced today, since the same check applies as for assistant runs).

Note

Enabling/disabling additional document uploads in the workflow editor only affects the chat UI — API calls can always attach files regardless of that setting.

Document output response

When a workflow's output format produces a document (e.g. DOCX, PDF, PPTX, or a table/Excel output), the response from POST /workflows/v1/{workflowId}/run does not contain the file itself. Instead, the documentUrl field returns a signed download link valid for approximately one hour. To retrieve the actual file, make a separate GET request to that documentUrl - only that response contains the file bytes, with the correct Content-Type and Content-Disposition.

Automations (e.g. Power Automate, Make, n8n) that want to save or forward the generated document therefore need two steps: trigger the workflow run and read documentUrl from the response, then download the file via a second HTTP GET step. Because the link expires after about an hour, this second step should happen promptly and should not be part of a long-running, multi-hour approval process.

Practical Usage

Was this page helpful?