Sigma Computing

Sigma Computing Workbooks API

The Workbooks API from Sigma Computing — 44 operation(s) for workbooks.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 60

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/workbooks List workbooks I can access · List workbooks #
Ask an LLM
“Which Sigma workbooks do I have access to?”
“Can an admin see every workbook in the organization, not just their own?”
Tell an agent
List all the workbooks I can open.
List archived workbooks only, {limit} per page.
POST /v2/workbooks Create an empty workbook · Create a workbook #
Ask an LLM
“How do I create a blank workbook through the API?”
“Can I choose which folder a new empty workbook is saved in?”
Tell an agent
Create an empty workbook named {name} in folder {folderId}.
Create a blank workbook {name} in folder {folderId} owned by user {ownerId}.
GET /v2/workbooks/{workbookId} Get a workbook's details · Get a workbook #
Ask an LLM
“How do I look up a single workbook's name, URL and path?”
“What metadata comes back for one workbook by its ID?”
Tell an agent
Get the details of workbook {workbookId}.
Show me the URL and folder path of workbook {workbookId}.
GET /v2/workbooks/{workbookId}/bookmarks List bookmarks in a workbook · List bookmarks in a workbook #
Ask an LLM
“Which bookmarks exist on a workbook, including ones shared with me?”
“How can I review the saved bookmarks on an untagged workbook?”
Tell an agent
List the bookmarks on workbook {workbookId}.
Show bookmarks shared with me in workbook {workbookId}.
POST /v2/workbooks/{workbookId}/bookmarks Add a bookmark to a workbook · Add a bookmark to a workbook #
Ask an LLM
“How do I save an exploration as a bookmark on a workbook?”
“Can a new workbook bookmark be shared with other people when I create it?”
Tell an agent
Add a bookmark called {name} to workbook {workbookId} using explore key {exploreKey}.
Bookmark version {workbookVersion} of workbook {workbookId} as {name}, shared: {isShared}, from exploration {exploreKey}.
GET /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Get one bookmark on a workbook · Get a bookmark #
Ask an LLM
“How do I fetch the details of a single bookmark on a regular workbook?”
“What does one workbook bookmark record contain?”
Tell an agent
Get bookmark {bookmarkId} on workbook {workbookId}.
Show the details of workbook {workbookId}'s bookmark {bookmarkId}.
PATCH /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Update a workbook bookmark · Update a workbook bookmark #
Ask an LLM
“How do I point an existing workbook bookmark at a new exploration?”
“Can I make a bookmark the default view of a workbook?”
Tell an agent
Rename bookmark {bookmarkId} on workbook {workbookId} to {name}.
Make bookmark {bookmarkId} the default for workbook {workbookId}: {isDefault}.
DELETE /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Delete a bookmark from a workbook · Delete a bookmark from a workbook #
Ask an LLM
“How do I remove a bookmark I no longer need from an untagged workbook?”
“Can I delete someone's shared bookmark from a workbook by its ID?”
Tell an agent destructive · confirm first
Delete bookmark {bookmarkId} from workbook {workbookId}.
Remove the {bookmarkId} bookmark on workbook {workbookId}.
GET /v2/workbooks/{workbookId}/columns List columns across a workbook · List columns for all elements in a workbook #
Ask an LLM
“How can I see every column used in every element of a workbook at once?”
“What columns does a whole workbook contain?”
Tell an agent
List all columns across every element in workbook {workbookId}.
Give me the full column inventory for workbook {workbookId}.
GET /v2/workbooks/{workbookId}/controls List a workbook's controls · List workbook controls #
Ask an LLM
“Which interactive controls like dropdowns and checkboxes does a workbook have?”
“How do I find the filter controls in a workbook?”
Tell an agent
List the controls in workbook {workbookId}.
Show the dropdowns and checkboxes defined in workbook {workbookId}.
POST /v2/workbooks/{workbookId}/convertToReport Convert a workbook into a report · Convert a workbook to a report #
Ask an LLM
“Can I turn a workbook into a report without changing the original?”
“What happens to workbook elements that reports don't support during conversion?”
Tell an agent
Convert workbook {workbookId} into a new report called {name}.
Convert only pages {pageIds} of workbook {workbookId} into report {name} in folder {destinationFolderId}.
POST /v2/workbooks/{workbookId}/copy Duplicate a workbook · Duplicate a workbook #
Ask an LLM
“How do I make a copy of a workbook as a backup?”
“Can a duplicated workbook keep the original's bookmarks?”
Tell an agent
Duplicate workbook {workbookId} as {name} into folder {destinationFolderId}.
Copy the latest workbook {workbookId} to folder {destinationFolderId} named {name}, copying bookmarks: {copyBookmarks}.
GET /v2/workbooks/{workbookId}/elements List elements in a workbook · List elements in a workbook #
Ask an LLM
“What charts, tables and controls make up a workbook across all its pages?”
“Can I list the elements of a workbook as they appear under a specific bookmark?”
Tell an agent
List every element in workbook {workbookId}.
List the elements of workbook {workbookId} under bookmark {bookmarkId}.
GET /v2/workbooks/{workbookId}/elements/{elementId}/columns List columns of one workbook element · List columns for a workbook element #
Ask an LLM
“What columns and formulas does a specific chart or table in a workbook use?”
“How do I see the column metadata for a single workbook element?”
Tell an agent
List the columns of element {elementId} in workbook {workbookId}.
Show column names and formulas for workbook {workbookId} element {elementId}.
POST /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Schedule materialization for a workbook element · Create a materialization schedule for a workbook element (Beta) #
Ask an LLM
“How do I set up a recurring materialization for one workbook element?”
“Can I cache an element's data on a schedule to speed it up?”
Tell an agent
Create a materialization schedule {schedule} for element {elementId} in workbook {workbookId}.
Start materializing workbook {workbookId} element {elementId} on cadence {schedule}.
PATCH /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Change an element's materialization schedule · Update a materialization schedule for a workbook element (Beta) #
Ask an LLM
“Can I change the cadence or timezone of an existing element materialization schedule?”
“How do I adjust when an element materializes without recreating the schedule?”
Tell an agent
Update the materialization schedule for element {elementId} in workbook {workbookId} to {schedule}.
Change workbook {workbookId} element {elementId} to materialize on cadence {schedule} instead.
DELETE /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Delete an element's materialization schedule · Delete a materialization schedule for a workbook element (Beta) #
Ask an LLM
“How do I stop scheduled materialization runs for a workbook element?”
“Does deleting a materialization schedule cancel the upcoming runs?”
Tell an agent destructive · confirm first
Delete the materialization schedule on element {elementId} of workbook {workbookId}.
Cancel future materializations for workbook {workbookId} element {elementId}.
GET /v2/workbooks/{workbookId}/elements/{elementId}/query Get the SQL behind a workbook element · Get the SQL query for a workbook element #
Ask an LLM
“What SQL does a particular workbook chart or table run?”
“How do I debug the query generated for one workbook element?”
Tell an agent
Show the SQL query for element {elementId} in workbook {workbookId}.
Get the SQL of workbook {workbookId} element {elementId} as seen under bookmark {bookmarkId}.
GET /v2/workbooks/{workbookId}/embeds List a workbook's embeds · Get embeds for a workbook #
Ask an LLM
“Which embed URLs have been created for a workbook?”
“How can I tell whether a workbook embed is public?”
Tell an agent
List the embeds for workbook {workbookId}.
Show the embed URLs and public status for workbook {workbookId}.
POST /v2/workbooks/{workbookId}/embeds Create an embed for a workbook · Create an embed for a workbook #
Ask an LLM
“How do I embed a whole workbook, a page or a single element in my app?”
“Can I create a public embed for a workbook?”
Tell an agent
Create a {embedType} embed of workbook {workbookId} with source type {sourceType}.
Embed element {sourceId} of workbook {workbookId} as a {embedType} embed, source type {sourceType}.
DELETE /v2/workbooks/{workbookId}/embeds/{embedId} Delete an embed from a workbook · Delete an embed from a workbook #
Ask an LLM
“How do I clean up an outdated embed on a workbook?”
“Can I revoke a workbook embed so its URL stops working?”
Tell an agent destructive · confirm first
Delete embed {embedId} from workbook {workbookId}.
Remove the outdated embed {embedId} on workbook {workbookId}.
POST /v2/workbooks/{workbookId}/export Export workbook data to a file · Export data from a workbook #
Ask an LLM
“How do I export a workbook's data as a CSV, PDF or JSON file?”
“Is there a row limit I can set when exporting workbook data?”
Tell an agent
Export workbook {workbookId} as {exportAs}.
Export up to {rowLimit} rows from workbook {workbookId} starting at offset {offset}.
POST /v2/workbooks/{workbookId}/grants Share a workbook with users or teams · Grant permissions on a workbook to users or teams #
Ask an LLM
“How do I give a team edit or view access to a workbook?”
“Can I grant workbook permissions to several users in one request?”
Tell an agent
Grant these permissions on workbook {workbookId}: {grants}.
Give the users and teams in {grants} access to workbook {workbookId}.
DELETE /v2/workbooks/{workbookId}/grants/{grantId} Revoke a workbook permission grant · Delete a workbook grant #
Ask an LLM
“How do I take away someone's access to a workbook?”
“What happens when I delete a grant on a workbook?”
Tell an agent destructive · confirm first
Delete grant {grantId} on workbook {workbookId}.
Revoke workbook {workbookId} access granted by {grantId}.
GET /v2/workbooks/{workbookId}/lineage Get the full lineage of a workbook · List lineage for a workbook #
Ask an LLM
“Which data sources feed a workbook, and what is upstream of them?”
“How is data connected across all the elements of a workbook?”
Tell an agent
Show the lineage of every element and source in workbook {workbookId}.
Map the upstream data sources for workbook {workbookId}.
GET /v2/workbooks/{workbookId}/lineage/elements/{elementId} Get the lineage of one workbook element · List lineage of a workbook element #
Ask an LLM
“What does a single chart in a workbook depend on?”
“How do I trace one element's data back to its sources?”
Tell an agent
Show the lineage of element {elementId} in workbook {workbookId}.
Trace the dependencies of workbook {workbookId} element {elementId}.
GET /v2/workbooks/{workbookId}/materialization-schedules List a workbook's materialization schedules (v2) · List materialization schedules for a workbook #
Ask an LLM
“When are the elements of a workbook set to materialize, using the original v2 endpoint?”
“Does the v2 materialization schedule list paginate only when I pass a limit?”
Tell an agent
List materialization schedules for workbook {workbookId} with the v2 endpoint.
Using the v2 list, show {limit} materialization schedules of workbook {workbookId} per page.
POST /v2/workbooks/{workbookId}/materializations Run a materialization now · Run a scheduled materialization for a workbook element #
Ask an LLM
“How do I trigger a scheduled materialization to run immediately?”
“Can I refresh the cached data for a workbook element on demand?”
Tell an agent
Run the materialization for sheet {sheetId} in workbook {workbookId} now.
Kick off an immediate materialization of element {sheetId} in workbook {workbookId}.
GET /v2/workbooks/{workbookId}/materializations/{materializationId} Check a materialization job's status · Get a materialization job #
Ask an LLM
“Did my materialization job finish, and when did it start and complete?”
“How do I troubleshoot a materialization run that seems stuck?”
Tell an agent
Get the status of materialization {materializationId} on workbook {workbookId}.
Check whether materialization job {materializationId} for workbook {workbookId} has completed.
GET /v2/workbooks/{workbookId}/pages List the pages of a workbook · List workbook pages for a workbook #
Ask an LLM
“What pages does a workbook have?”
“Can I list the pages of a tagged version of a workbook?”
Tell an agent
List the pages in workbook {workbookId}.
List pages of workbook {workbookId} for version tag {tag}.
GET /v2/workbooks/{workbookId}/pages/{pageId}/elements List elements on one workbook page · List elements in a workbook page #
Ask an LLM
“Which charts and tables sit on a specific page of a workbook?”
“How do I see only one page's elements instead of the whole workbook?”
Tell an agent
List the elements on page {pageId} of workbook {workbookId}.
Show what is on page {pageId} of workbook {workbookId} under bookmark {bookmarkId}.
GET /v2/workbooks/{workbookId}/queries List all SQL queries in a workbook · List SQL queries in a workbook #
Ask an LLM
“How can I audit every SQL query a workbook runs?”
“Is there a way to pull all of a workbook's queries at once rather than element by element?”
Tell an agent
List all SQL queries in workbook {workbookId}.
Pull every query workbook {workbookId} uses so I can review it.
POST /v2/workbooks/{workbookId}/restoreVersion Restore a workbook to an earlier version · Restore a workbook to a previous version #
Ask an LLM
“How do I roll a workbook back to a previous version?”
“Does restoring an old workbook version overwrite the newer versions?”
Tell an agent
Restore workbook {workbookId} to version {version}.
Roll back workbook {workbookId} by republishing version {version}.
POST /v2/workbooks/{workbookId}/saveTemplate Save a workbook as a template · Save a template from a workbook #
Ask an LLM
“How do I turn an existing workbook into a reusable template?”
“Can I pick who owns a template created from a workbook?”
Tell an agent
Save workbook {workbookId} as a template named {name}.
Create a template from workbook {workbookId} owned by {ownerId}.
GET /v2/workbooks/{workbookId}/schedules List a workbook's scheduled exports (v2) · List scheduled workbook exports #
Ask an LLM
“What scheduled exports are set up on a workbook, using the original v2 endpoint?”
“Will the v2 scheduled-export list stay unpaginated if I omit the limit?”
Tell an agent
List scheduled exports for workbook {workbookId} with the v2 endpoint.
Using the v2 schedules list, show {limit} exports per page for workbook {workbookId}.
POST /v2/workbooks/{workbookId}/schedules Schedule a recurring workbook export · Add workbook schedule #
Ask an LLM
“How do I email workbook data to people every week automatically?”
“Can I schedule a workbook export to a Slack channel or cloud storage?”
Tell an agent
Schedule workbook {workbookId} to export to {target} on schedule {schedule}.
Add a recurring export of workbook {workbookId} to {target} at {schedule}, described as {description}.
PATCH /v2/workbooks/{workbookId}/schedules/{scheduleId} Update or pause a scheduled export · Update a workbook schedule #
Ask an LLM
“Can I pause a scheduled workbook export without deleting it?”
“How do I change the recipients or timing of an existing export schedule?”
Tell an agent
Change schedule {scheduleId} on workbook {workbookId} to run at {schedule}.
Apply suspension action {suspensionAction} to schedule {scheduleId} on workbook {workbookId}.
DELETE /v2/workbooks/{workbookId}/schedules/{scheduleId} Delete a scheduled workbook export · Delete a scheduled export for a workbook #
Ask an LLM
“How do I stop a recurring workbook export from sending?”
“Can I remove an alert schedule from a workbook?”
Tell an agent destructive · confirm first
Delete scheduled export {scheduleId} from workbook {workbookId}.
Stop and remove schedule {scheduleId} on workbook {workbookId}.
GET /v2/workbooks/{workbookId}/schema Get a workbook's schema (deprecated) · Get workbook schema #
Ask an LLM
“Is the old workbook schema endpoint still usable with workbook layouts?”
“Can the deprecated workbook schema call include the SQL for each element?”
Tell an agent
Get the deprecated schema for workbook {workbookId}.
Fetch the legacy schema of workbook {workbookId} including SQL: {includeSql}.
POST /v2/workbooks/{workbookId}/send Send a workbook export to destinations now · Export a workbook #
Ask an LLM
“How do I send a one-off workbook export to an email address or Slack channel?”
“Can I send a workbook as a specific user with conditions attached?”
Tell an agent
Send workbook {workbookId} to {targets} with attachments {attachments} and config {config}.
Send workbook {workbookId} now as user {sendAsUser} to {targets}, attaching {attachments}, using config {config}.
POST /v2/workbooks/{workbookId}/shareCrossOrg Share a workbook with another organization · Share a workbook with another organization #
Ask an LLM
“How do I share a workbook or template with a different Sigma organization?”
“Can I include input table data when sharing a workbook across orgs?”
Tell an agent
Share workbook {workbookId} with organizations {orgSlugs}.
Share workbook {workbookId} with {orgSlugs} and email them {emailMessage}.
GET /v2/workbooks/{workbookId}/sources List a workbook's data sources · List workbook sources #
Ask an LLM
“Which tables, datasets or data models does a workbook pull from?”
“Does a workbook use custom SQL as one of its sources?”
Tell an agent
List the data sources of workbook {workbookId}.
Show which tables and data models feed workbook {workbookId}.
GET /v2/workbooks/{workbookId}/spec Export a workbook as code · Get the code representation of a workbook (Beta) #
Ask an LLM
“Can I get a workbook's full definition as YAML or JSON?”
“How do I pull the code representation of an older workbook version?”
Tell an agent
Get the code representation of workbook {workbookId} as {format}.
Fetch the spec for version {documentVersion} of workbook {workbookId}.
PUT /v2/workbooks/{workbookId}/spec Replace a workbook from its code definition · Update a workbook from a code representation (Beta) #
Ask an LLM
“How do I update an existing workbook by pushing an edited code representation?”
“Can I change a workbook's theme through its code definition?”
Tell an agent
Replace workbook {workbookId} with the code definition using layout {layout}.
Update workbook {workbookId} from code and set its theme to {themeName}.
POST /v2/workbooks/{workbookId}/swapSources Swap a workbook's connection or sources · Swap workbook data sources #
Ask an LLM
“How do I point a workbook at a different warehouse connection?”
“Can I swap a workbook from one table to another and keep input table data?”
Tell an agent
Swap the connections of workbook {workbookId} using mapping {connectionMapping}.
Swap the tables behind workbook {workbookId} per {sourceMapping} with the v2 swap endpoint.
POST /v2/workbooks/{workbookId}/tag/{versionTag}/copy Duplicate a tagged workbook version · Duplicate a tagged workbook #
Ask an LLM
“How do I create a new workbook from a version-tagged release?”
“Can I copy the production-tagged version of a workbook into another folder?”
Tell an agent
Duplicate the {versionTag} version of workbook {workbookId} as {name} in folder {destinationFolderId}.
Copy tagged workbook {workbookId} at tag {versionTag} into {destinationFolderId} named {name}.
GET /v2/workbooks/{workbookId}/tags Get version tags on a workbook · Get tags for a workbook #
Ask an LLM
“Which version tags are applied to a workbook?”
“How do I check a workbook's tag metadata on demand?”
Tell an agent
List the version tags on workbook {workbookId}.
Show tag information for workbook {workbookId}.
DELETE /v2/workbooks/{workbookId}/tags/{tagId} Remove a version tag from a workbook · Remove a tag from a workbook #
Ask an LLM
“How do I untag a workbook when a release stage is over?”
“Can I remove a single version tag from a workbook?”
Tell an agent destructive · confirm first
Remove tag {tagId} from workbook {workbookId}.
Untag workbook {workbookId} by deleting version tag {tagId}.
GET /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks List bookmarks in a tagged workbook · List bookmarks in a tagged workbook #
Ask an LLM
“Which bookmarks exist on a version-tagged workbook?”
“How do I see bookmarks for the production tag of a workbook?”
Tell an agent
List bookmarks on workbook {workbookId} at tag {tagName}.
Show the {tagName}-tagged bookmarks of workbook {workbookId}.
POST /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/ Add a bookmark to a tagged workbook · Add a bookmark to a tagged workbook #
Ask an LLM
“How do I add a bookmark to a version-tagged workbook?”
“Can bookmarks on a tagged workbook be shared with everyone?”
Tell an agent
Add bookmark {name} to workbook {workbookId} at tag {tagName} using explore key {exploreKey}.
On tagged workbook {workbookId} ({tagName}), bookmark version {workbookVersion} as {name}, shared {isShared}, from {exploreKey}.
GET /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Get a bookmark in a tagged workbook · Get a bookmark in a tagged workbook #
Ask an LLM
“How do I read one bookmark on a version-tagged workbook?”
“What details are stored for a bookmark under a workbook tag?”
Tell an agent
Get bookmark {bookmarkId} on workbook {workbookId} at tag {tagName}.
Show tagged bookmark {bookmarkId} in the {tagName} version of workbook {workbookId}.
PATCH /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Update a bookmark in a tagged workbook · Update a bookmark in a tagged workbook #
Ask an LLM
“How do I rename a bookmark on a version-tagged workbook?”
“Can I set the default bookmark for a tagged workbook version?”
Tell an agent
Rename bookmark {bookmarkId} on workbook {workbookId} at tag {tagName} to {name}.
Set tagged bookmark {bookmarkId} ({tagName}) on workbook {workbookId} as default: {isDefault}.
DELETE /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Delete a bookmark from a tagged workbook · Delete a bookmark from a tagged workbook #
Ask an LLM
“How do I remove a bookmark from the tagged version of a workbook?”
“Can I delete a bookmark that only exists under a version tag?”
Tell an agent destructive · confirm first
Delete bookmark {bookmarkId} from workbook {workbookId} at tag {tagName}.
Remove tagged bookmark {bookmarkId} in the {tagName} version of workbook {workbookId}.
GET /v2/workbooks/{workbookId}/version-history Get a workbook's version history · Get version history for a workbook #
Ask an LLM
“How can I see every published version of a workbook?”
“Which versions of a workbook were given a version tag?”
Tell an agent
Show the version history of workbook {workbookId}.
List past versions of workbook {workbookId} and any tags on them.
POST /v2/workbooks/spec Create a workbook from a code definition · Create a workbook from a code representation (Beta) #
Ask an LLM
“Can I create a brand new workbook from a JSON or YAML definition?”
“How do I programmatically build a workbook as code?”
Tell an agent
Create workbook {name} in folder {folderId} from my code representation.
Build a new workbook from code named {name} in {folderId} with description {description}.
POST /v2/workbooks/spec/verify Validate a workbook code definition · Verify a workbook code representation (Beta) #
Ask an LLM
“Can I check a workbook code representation is valid without creating anything?”
“How do I dry-run a workbook definition before I build it?”
Tell an agent
Verify the workbook definition {name} for folder {folderId} without saving it.
Dry-run validate my workbook code named {name} targeting folder {folderId}.
POST /v2/workbooks/tag Apply a version tag to a workbook · Tag a workbook #
Ask an LLM
“How do I tag a workbook version for production?”
“Can tagging a workbook also swap it to a different connection for that version?”
Tell an agent
Tag workbook {workbookId} with {tag}.
Tag version {workbookVersion} of workbook {workbookId} as {tag} with source mapping {sourceMappingConfig}.
GET /v2.1/workbooks/{workbookId}/materialization-schedules List materialization schedules (paginated v2.1) · List materialization schedules for a workbook (Paginated) #
Ask an LLM
“Which endpoint pages through a workbook's materialization schedules by default?”
“How do I page through many materialization schedules on the v2.1 API?”
Tell an agent
Page through materialization schedules for workbook {workbookId} using v2.1.
Get page {page} of v2.1 materialization schedules for workbook {workbookId}.
GET /v2.1/workbooks/{workbookId}/schedules List scheduled exports (paginated v2.1) · List scheduled workbook exports (Paginated) #
Ask an LLM
“Which endpoint returns a workbook's scheduled exports paginated by default?”
“How do I page through a long list of export schedules on the v2.1 API?”
Tell an agent
Page through scheduled exports of workbook {workbookId} using v2.1.
Get page {page} of v2.1 export schedules for workbook {workbookId}.
POST /v3alpha/workbooks/{workbookId}:swapSources Swap each workbook source (v3alpha beta) · Swap workbook sources (Beta) #
Ask an LLM
“Can I swap a workbook source to a data model element or custom SQL element?”
“How do I remap each individual data source of a workbook with the beta swap?”
Tell an agent
Using the v3alpha swap, remap each source of workbook {workbookId} per {sourceMapping}.
Swap workbook {workbookId}'s sources to data model elements with beta mapping {sourceMapping}.

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-workbooks-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing:sigma-computing-workbooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-workbooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Workbooks API
  version: '1.0'
  description: 'Operations tagged workbooks across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:


# --- truncated at 32 KB (14704 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-workbooks-api-openapi.yml