For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Documentation API Reference SDKs

Documentation API Reference SDKs

Documents
Search
- POSTsearch.content
- POSTsearch.documents
Buckets
Groups
Workflows
Customer
- GETget
API Key
Health
- GETlist
- GETget

add_to_id

POST

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

POST

/api/v1/workflow/relationship/:id

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY_HERE",
5 )
6 
7 client.workflows.add_to_id(
8     id=1,
9     workflow_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
10 )

200Successful

1 {
2   "message": "Workflow successfully assigned to group 1"
3 }

Assigns the given workflow to the group or bucket and is applied by default to all files unless overridden by document workflows.

Was this page helpful?

remove_from_id

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idintegerRequired

The id of the group or bucket that the workflow will be assigned to.

Request

This endpoint expects an object.

workflowIdstringRequiredformat: "uuid"

The id of the workflow that is being applied.

Response

Apply success

messagestring