> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.eyelevel.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.eyelevel.ai/_mcp/server. # get_account GET https://api.groundx.ai/api/v1/workflow/relationship Get the workflow associated with customer account. Reference: https://docs.eyelevel.ai/reference/api-reference/workflows/get-account ## Authentication - `X-API-Key` header (required) — API Key authentication via header ## Response ### 200 Lookup successful - `workflow` (WorkflowDetail, required) — Workflow information ## Types ### WorkflowDetail Workflow information - `chunkStrategy` (enum, optional) - Allowed values: `element`, `size` - `documentId` (string, optional) — The documentId associated with the workflow - `id` (integer, optional) — The bucketId or groupId associated with the workflow - `name` (string, optional) — The human-readable name of the workflow - `updatedAt` (string, optional) — The UTC timestamp when the workflow row was last updated. - `extract` (WorkflowDetailExtract, optional) — Extract agent definitions. - `template` (map from string to string, optional) — Workflow-level prompt template values used by fixed and custom workflow step prompts. - `sectionStrategy` (enum, optional) - Allowed values: `chunks`, `page` - `steps` (WorkflowSteps, optional) — A collection of workflow steps - `customSteps` (list of CustomWorkflowStep, optional) — Workflow-level custom extraction steps. Legacy fixed steps remain under steps. - `outputRoutes` (list of CustomWorkflowOutputRoute, optional) — Custom output routes. Each record must have exactly one matching leafFields record on finalPath, workflowGroup, workflowField, stepName, level, and outputKey. - `leafFields` (list of CustomWorkflowLeafField, optional) — Custom leaf-field metadata used to validate route integrity and executable-step field counts. - `relationships` (WorkflowDetailRelationships, optional) — Resources associated with this workflow. - `workflowId` (string, optional) — Unique system generated ID for the workflow ### WorkflowDetailExtract Extract agent definitions. ### WorkflowSteps A collection of workflow steps - `chunk-instruct` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `chunk-keys` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `chunk-summary` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `doc-keys` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `doc-summary` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `search-query` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `sect-instruct` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `sect-keys` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. - `sect-summary` (WorkflowStep, optional) — Agent settings, including its LLM and prompts. ### CustomWorkflowStep Workflow-level custom extraction step definition. Fixed workflow steps remain under steps. - `name` (string, required) — Canonical lower-snake custom step name. Names are globally unique and cannot collide with fixed step names or reserved workflow metadata names. - `level` (enum, required) — Output level for the custom step. - Allowed values: `chunk`, `section`, `document` - `kind` (enum, required) — Output kind for the custom step. Valid combinations are chunk/section with instruct, keys, or summary; document with keys or summary. - Allowed values: `instruct`, `keys`, `summary` - `config` (CustomWorkflowStepConfig, optional) — Custom workflow step config keyed by element type. Element configs omit fixed-output field; custom output storage is derived from level, kind, outputRoutes, and leafFields. - `requiredTemplateKeys` (list of string, optional) — Workflow template keys required by this custom step. Keys follow the same normalization and validation rules as template keys. ### CustomWorkflowOutputRoute Public custom output route metadata. Each route must have exactly one matching leafFields record on finalPath, workflowGroup, workflowField, stepName, level, and outputKey. - `workflowGroup` (string, required) — Workflow extraction group that owns the routed field. - `workflowField` (string, required) — Workflow extraction field routed to the final JSON path. - `finalPath` (string, required) — RFC 6901 JSON Pointer to the final JSON field. Repeated item paths use a literal * segment as a schema wildcard; for example, the pointer with segments fees, *, and amount represents a repeated item amount. - `stepName` (string, required) — Canonical custom step name that produced the output. - `level` (enum, required) - Allowed values: `chunk`, `section`, `document` - `outputMap` (enum, required) — Custom X-Ray output map that stores this route's values. The map must match level. - Allowed values: `customChunkOutputs`, `customSectionOutputs`, `customDocumentOutputs` - `outputKey` (string, required) — Lower-snake output key for this custom step output. - `readbackPath` (string, required) — Canonical non-page X-Ray/readback path template for this routed output. ### CustomWorkflowLeafField Public custom leaf-field metadata used for route integrity and executable-step field-count validation. - `finalPath` (string, required) — RFC 6901 JSON Pointer to the prompted final schema leaf. Repeated item paths use a literal * segment and count once per prompted schema leaf. - `workflowGroup` (string, required) - `workflowField` (string, required) - `stepName` (string, required) - `level` (enum, required) - Allowed values: `chunk`, `section`, `document` - `outputKey` (string, required) - `fieldType` (string, required) — Final schema field type for this prompted leaf. - `isRepeated` (boolean, required) — Whether this leaf belongs to a repeated/list field definition. - `repetitionScope` (enum, required) — none is valid only for non-repeated leaves; field counts a repeated value as one prompted leaf; item uses literal * path segments for prompted item leaves. - Allowed values: `none`, `field`, `item` ### WorkflowDetailRelationships Resources associated with this workflow. - `account` (boolean, optional) — A boolean indicating whether the workflow is associated with the account - `documents` (list of string, optional, nullable) — An array of documentIds associated with the workflow - `ids` (list of integer, optional) — An array of bucketIds or groupIds associated with the workflow ### WorkflowStep Agent settings, including its LLM and prompts. - `all` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. - `figure` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. - `json` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. - `paragraph` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. - `table` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. - `table-figure` (WorkflowStepConfig, optional) — Agent settings, including its LLM and prompts. ### CustomWorkflowStepConfig Custom workflow step config keyed by element type. Element configs omit fixed-output field; custom output storage is derived from level, kind, outputRoutes, and leafFields. - `all` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `figure` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `json` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `paragraph` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `table` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `table-figure` (CustomWorkflowStepElementConfig, optional) — Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. ### WorkflowStepConfig Agent settings, including its LLM and prompts. - `engine` (WorkflowEngine, optional) — LLM settings for a workflow agent. - `field` (enum, optional) — The field where agent output will be saved - Allowed values: `doc-sum`, `doc-keys`, `sect-sum`, `sect-keys`, `chunk-sum`, `chunk-keys`, `chunk-instruct`, `text` - `includes` (map from string to boolean, optional) - `prompt` (WorkflowPromptGroup, optional) — Prompts for this step. On update, omit prompt or send to use defaults. Send an object to customize its supplied members, or null to remove the prompt group. ### CustomWorkflowStepElementConfig Element-level custom workflow step config. It supports existing prompt, engine, and include settings; fixed-output field is omitted because custom output routing is defined by outputRoutes and leafFields. - `engine` (WorkflowEngine, optional) — LLM settings for a workflow agent. - `includes` (map from string to boolean, optional) - `prompt` (WorkflowPromptGroup, optional) — Prompts for this custom step element. On update, omit prompt or send to use defaults. Send an object to customize its supplied members, or null to remove the prompt group. ### WorkflowEngine LLM settings for a workflow agent. - `apiKey` (string, optional) — Credential sent using the selected service's authentication scheme - `baseURL` (string, optional) — The provider base URL used for requests by the selected service - `engineID` (string, optional) — The model name that will be included in the request - `maxImages` (integer, optional) — Maximum images per request for this engine. Defaults to 50. An explicit value overrides the default. If the limit is exceeded, GroundX removes earlier images and keeps text and later images. Normal workflow and step engine precedence applies; no route-specific image limit overrides the selected engine. The separate openai-base64 request-size limit still applies. - `reasoningEffort` (enum, optional) — An enumerated value that conforms to OpenAI '/chat/completion' specifications - Allowed values: `minimal`, `low`, `medium`, `high` - `requestHeaders` (map from string to string, optional) — Extra LLM request headers with string values, such as OpenAI-Project for usage tracking. They override headers set by GroundX. Set apiKey on the same engine; workflow create and update reject requestHeaders without it. GroundX sends the headers unchanged, but the provider may ignore them. - `requestPassthrough` (map from string to any, optional) — Extra JSON fields merged into the LLM request body. These values override fields generated by GroundX when names match. - `service` (enum, optional) — Selects how requests are configured for the provider. Anthropic uses the native Messages API with baseURL, apiKey, engineID, requestHeaders, and requestPassthrough. - Allowed values: `openai`, `openai-base64`, `azure`, `deep-infra`, `hosted`, `bedrock`, `anthropic` ### WorkflowPromptGroup Request and task prompts. On workflow update, omitted members use defaults; null removes a member. - `request` (WorkflowPrompt, optional) — The request prompt. On workflow update, omit this member to use the default and send null to remove it. - `task` (WorkflowPrompt, optional) — The task prompt. On workflow update, omit this member to use the default and send null to remove it. ### WorkflowPrompt Prompt settings for a workflow agent. - `abbreviated` (string, optional) — Short prompt included in the chat history as context. - `additionalContext` (string, optional) — Extra instructions appended to a default request or task prompt, limited to 4096 UTF-8 bytes. Omit to leave the prompt unchanged. This value overrides workflow-level template.CUSTOM_INSTRUCTIONS for the same prompt. Supported only on fixed default request and task prompts in GPT and EyeLevel workflows. The server rejects it under customSteps, useExtras or prompts that replace the full prompt, even where this shared schema appears. - `prompt` (string, optional) — The prompt that is sent to the LLM - `role` (enum, optional) — An enumerated value that conforms to OpenAI '/chat/completion' specifications - Allowed values: `assistant`, `developer`, `system`, `user` ## Examples **Response** ```json { "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" } } ``` **SDK Code** ```python import requests url = "https://api.groundx.ai/api/v1/workflow/relationship" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.groundx.ai/api/v1/workflow/relationship'; const options = {method: 'GET', headers: {'X-API-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.groundx.ai/api/v1/workflow/relationship" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.groundx.ai/api/v1/workflow/relationship") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-API-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.groundx.ai/api/v1/workflow/relationship") .header("X-API-Key", "") .asString(); ``` ```php request('GET', 'https://api.groundx.ai/api/v1/workflow/relationship', [ 'headers' => [ 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.groundx.ai/api/v1/workflow/relationship"); var request = new RestRequest(Method.GET); request.AddHeader("X-API-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["X-API-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.groundx.ai/api/v1/workflow/relationship")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```