SIsigmacomputing
workbookAgents

List agents

List the Sigma agents that you can edit across every workbook in the organization. An agent is returned when you own the workbook that defines it, or were granted Can edit access to it. Agents in workbooks that you can only view or explore are not included. Use the returned agentId and workbookId to run a Sigma agent. To list agents defined in a single workbook instead, use List agents in a workbook. For a guide to calling Sigma agents from the API, see Call Sigma agents with the API.

get/v2/workbookAgents

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pageTokenstring

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeinteger

Number of results to return per page, with a maximum of 100. Defaults to 20.

Response

The response body.

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

Changes

No recorded changes to this operation across all 1 revision of this API.