Workspaces API

Auto-generated from codebase analysis

This section documents the Workspaces API endpoints.

GET Endpoints

GET /admin-settings

Get admin settings for a workspace or globally

Parameters

Name	Type	Required	Description
workspace_name	Optional[str]	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/admin-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /user-preferences

Get user preferences for the current user

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/user-preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /global-settings

Get global settings for the organization

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/global-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /

List all workspaces with user preference information

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /current

Get current workspace details from cached config

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/current" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /source-config

Get source configuration for the current workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/source-config" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /target-schema/check

Check if target schema is assigned to the workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/target-schema/check" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /target-schema/content

Get the content of the assigned target schema

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/target-schema/content" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /target-schema/available

Get available target schemas for the current workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/target-schema/available" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /workflow-status

Get detailed workflow status for the current workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/workflow-status" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/workflow/state

Get the current workflow state for a workspace

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/workflow/state" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/config

Get complete configuration for a specific workspace

Parameters

Name	Type	Required	Description
workspace_name	str	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/config" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /metrics

Get metrics for the current workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}

Get workspace details by name

Parameters

Name	Type	Required	Description
workspace_name	str	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /schema

Get the schema for the current workspace

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/schema" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace}/database/check

Check if workspace database is configured and accessible

Parameters

Name	Type	Required	Description
workspace	str	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace}/database/check" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/system-prompt

Get the system prompt for a workspace (either custom or default)

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/system-prompt" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/git-diff

Get git diff for current workspace changes.

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/git-diff" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/prompt

Get the workspace prompt file that contains user-defined success criteria.

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/prompt" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /{workspace_name}/download

Download a compressed bundle of all files in the specified workspace.

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/{workspace_name}/download" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST Endpoints

POST /discover

SSE endpoint that invokes the Discovery Agent and streams JSON events.

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/discover" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /discover/cancel

Mark the current user's discovery operation as cancelled via OperationCache.

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/discover/cancel" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /admin-settings

Create new admin settings for a workspace

Parameters

Name	Type	Required	Description
admin_settings	AdminSettingsCreate	No

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/admin-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /user-preferences

Create/replace user preferences for the current user

Parameters

Name	Type	Required	Description
user_preferences	UserPreferencesCreate	No

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/user-preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /select

Select a workspace for the current user

Parameters

Name	Type	Required	Description
workspace_data	WorkspaceSelect	No

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/select" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /create

Create a new workspace

Parameters

Name	Type	Required	Description
workspace_data	WorkspaceCreate	No

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/create" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /source-config

Update source configuration for the current workspace

Parameters

Name	Type	Required	Description
source_config	Dict[str, Any]	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/source-config" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /target-schema/assign

Assign a target schema to the workspace

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/target-schema/assign" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace_name}/workflow/complete

Mark a workflow task as complete

Parameters

Name	Type	Required	Description
workspace_name	str	Yes
task_data	dict	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace_name}/workflow/complete" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace_name}/workflow/incomplete

Mark a workflow task as incomplete

Parameters

Name	Type	Required	Description
workspace_name	str	Yes
task_data	dict	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace_name}/workflow/incomplete" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace_name}/config

Save/update complete configuration for a specific workspace

Parameters

Name	Type	Required	Description
workspace_name	str	Yes
config_save	WorkspaceConfigSave	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace_name}/config" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /flush-cache

Flush the request cache for the current user, forcing a reload of user context

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/flush-cache" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /flush-mapping-cache

Flush the entire mapping cache and FileDAO caches.

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/flush-mapping-cache" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /test-stored-password

Test the stored password for the current workspace's datasource using the standard code path

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/test-stored-password" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /benchmark

Run internal performance benchmarks on filesystem, file DAO, and database operations

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/benchmark" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace}/database/test

Test database connection for workspace target configuration

Parameters

Name	Type	Required	Description
workspace	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace}/database/test" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace}/database/catalogs

Get list of available catalogs and warehouses for target database configuration.

Parameters

Name	Type	Required	Description
workspace	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace}/database/catalogs" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /{workspace_name}/system-prompt/clone

Clone the default system prompt to a workspace-specific version

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/{workspace_name}/system-prompt/clone" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT Endpoints

PUT /admin-settings

Update admin settings for a workspace

Parameters

Name	Type	Required	Description
admin_settings	AdminSettingsUpdate	No
workspace_name	Optional[str]	No

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/admin-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /user-preferences

Update user preferences for the current user

Parameters

Name	Type	Required	Description
user_preferences	UserPreferencesUpdate	No

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/user-preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /global-settings

Update global settings for the organization

Parameters

Name	Type	Required	Description
global_settings	GlobalSettingsUpdate	No

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/global-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /{workspace_name}

Update workspace details

Parameters

Name	Type	Required	Description
workspace_name	str	Yes
workspace_data	WorkspaceUpdate	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/{workspace_name}" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /{workspace_name}/system-prompt

Update the workspace-specific system prompt

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/{workspace_name}/system-prompt" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /{workspace_name}/prompt

Update the workspace prompt file with user-defined success criteria.

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/{workspace_name}/prompt" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE Endpoints

DELETE /admin-settings

Delete admin settings for a workspace

Parameters

Name	Type	Required	Description
workspace_name	Optional[str]	No

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/admin-settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /user-preferences

Delete user preferences for the current user

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/user-preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /{workspace_name}

Delete a workspace

Parameters

Name	Type	Required	Description
workspace_name	str	No

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/{workspace_name}" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /{workspace_name}/system-prompt

Delete the workspace-specific system prompt and revert to default

Parameters

Name	Type	Required	Description
workspace_name	str	Yes

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/{workspace_name}/system-prompt" \
  -H "Authorization: Bearer YOUR_TOKEN"