API

Use the CloudSigma HTTP API to manage workspace resources. These pages organize the API by development task; each task page links to the field-level API Reference for exact methods, parameters, and response schemas.

Before you call

  • Use the API base URL for the region that contains the target workspace.

  • Pass a personal access token in X-API-Key.

  • Pass the target workspace ID in X-Workspace-ID for workspace-scoped operations.

  • Keep resource IDs and run IDs returned by create or execute operations; later status and result requests use those identifiers.

To test the connection first, complete Make your first AI Studio API call.

Choose a task

Section

Use it when

Resource Center

Manage workspaces, catalogs, databases, tables, file storage, compute resources, and data sharing.

Data connections

Connect external data and create import or export tasks.

Data processing

Manage workflows, operators, SQL, workbooks, and data dashboards.

Knowledge bases

Manage knowledge bases, data sources, segments, and semantic entries.

Agents

Create, invoke, configure, and monitor agents.

Monitoring

Query SQL execution records, operation logs, and task overviews.

Users and permissions

Manage users, roles, and data, object, and application permissions.

Last updated on