WebsitePlatform Login

Workflows

Workflow management and execution endpoints

GET/workflows/v1/user-workflows

Retrieves all workflows accessible to the authenticated user

Authorization

ApiKeyAuth
Authorization<token>

API key for authentication. Use 'Bearer ' format.

In: header

Header Parameters

Authorization*string

API key for authentication. Use 'Bearer ' format.

Response Body

application/json

application/json

curl -X GET "https://app.meingpt.com/api/workflows/v1/user-workflows" \  -H "Authorization: Bearer sk_meingpt_..."
{
  "status": "success",
  "workflows": [
    {}
  ]
}
{
  "status": "error",
  "message": "string"
}
GET/workflows/v1/workflow-inputs/{workflowId}

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

Authorization

ApiKeyAuth
Authorization<token>

API key for authentication. Use 'Bearer ' format.

In: header

Path Parameters

workflowId*string

The workflow ID

Header Parameters

Authorization*string

API key for authentication. Use 'Bearer ' format.

Response Body

application/json

application/json

application/json

curl -X GET "https://app.meingpt.com/api/workflows/v1/workflow-inputs/string" \  -H "Authorization: Bearer sk_meingpt_..."
{
  "status": "success",
  "inputs": [
    {
      "name": "string",
      "type": "string",
      "description": "string",
      "defaultValue": null,
      "options": [
        {
          "label": "string",
          "value": "string"
        }
      ]
    }
  ]
}
{
  "status": "error",
  "message": "string"
}
{
  "status": "error",
  "message": "string"
}
POST/workflows/v1/{workflowId}/run

Executes a workflow with the provided input parameters

Authorization

ApiKeyAuth
Authorization<token>

API key for authentication. Use 'Bearer ' format.

In: header

Path Parameters

workflowId*string

The workflow ID to execute

Header Parameters

Authorization*string

API key for authentication. Use 'Bearer ' format.

input*object

Input parameters for the workflow execution

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.meingpt.com/api/workflows/v1/string/run" \  -H "Authorization: Bearer sk_meingpt_..." \  -H "Content-Type: application/json" \  -d '{    "input": {}  }'
{
  "status": "success",
  "messages": [
    {
      "content": "string",
      "role": "user",
      "model": "string",
      "knowledgeCollectionSearchResults": [
        {
          "knowledgeCollectionId": "string",
          "knowledgeCollectionName": "string",
          "queries": [
            "string"
          ],
          "resultComponents": [
            {
              "documentId": "string",
              "documentTitle": "string",
              "score": 0,
              "result": "string",
              "sourceNumber": 0
            }
          ]
        }
      ]
    }
  ],
  "documentUrl": "string",
  "structuredOutput": {}
}
{
  "status": "error",
  "message": "string"
}
{
  "status": "error",
  "message": "string"
}
{
  "status": "error",
  "message": "string"
}
{
  "status": "error",
  "message": "string"
}

Practical Usage

On this page