get_account

GET

https://api.groundx.ai/api/v1/workflow/relationship

GET

/api/v1/workflow/relationship

from groundx import GroundX
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.workflows.get_account()

200Retrieved

{
  "workflow": {
    "chunkStrategy": "element",
    "documentId": "string",
    "id": 1,
    "name": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "extract": {},
    "template": {},
    "sectionStrategy": "chunks",
    "steps": {
      "chunk-instruct": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "chunk-keys": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "chunk-summary": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "doc-keys": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "doc-summary": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "search-query": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "sect-instruct": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "sect-keys": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      },
      "sect-summary": {
        "all": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "json": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "paragraph": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        },
        "table-figure": {
          "engine": {
            "apiKey": "string",
            "baseURL": "string",
            "engineID": "string",
            "maxImages": 1,
            "reasoningEffort": "minimal",
            "requestHeaders": {},
            "requestPassthrough": {},
            "service": "openai"
          },
          "field": "doc-sum",
          "includes": {},
          "prompt": {
            "request": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            },
            "task": {
              "abbreviated": "string",
              "additionalContext": "string",
              "prompt": "string",
              "role": "assistant"
            }
          }
        }
      }
    },
    "customSteps": [
      {
        "name": "string",
        "level": "chunk",
        "kind": "instruct",
        "config": {
          "all": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          },
          "figure": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          },
          "json": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          },
          "paragraph": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          },
          "table": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          },
          "table-figure": {
            "engine": {
              "apiKey": "string",
              "baseURL": "string",
              "engineID": "string",
              "maxImages": 1,
              "reasoningEffort": "minimal",
              "requestHeaders": {},
              "requestPassthrough": {},
              "service": "openai"
            },
            "includes": {},
            "prompt": {
              "request": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              },
              "task": {
                "abbreviated": "string",
                "additionalContext": "string",
                "prompt": "string",
                "role": "assistant"
              }
            }
          }
        },
        "requiredTemplateKeys": [
          "string"
        ]
      }
    ],
    "outputRoutes": [
      {
        "workflowGroup": "string",
        "workflowField": "string",
        "finalPath": "string",
        "stepName": "string",
        "level": "chunk",
        "outputMap": "customChunkOutputs",
        "outputKey": "string",
        "readbackPath": "string"
      }
    ],
    "leafFields": [
      {
        "finalPath": "string",
        "workflowGroup": "string",
        "workflowField": "string",
        "stepName": "string",
        "level": "chunk",
        "outputKey": "string",
        "fieldType": "string",
        "isRepeated": true,
        "repetitionScope": "none"
      }
    ],
    "relationships": {
      "account": true,
      "documents": [
        "string"
      ],
      "ids": [
        1
      ]
    },
    "workflowId": "string"
  }
}

Get the workflow associated with customer account.

Authentication

X-API-Keystring

API Key authentication via header

Response

Lookup successful

workflowobject

Workflow information