Workbooks
Run a Sigma agent
Run a Sigma agent and return its reply.
The API is stateless. Include the full conversation in messages on every call. To continue a conversation, append the response output to your messages and send them on the next call. The agent runs with your access against the workbook's latest published version unless you pass versionTagName. For a guide to calling Sigma agents from the API, see Call Sigma agents with the API.
Usage notes
- Retrieve the workbookId by calling the /v2/workbooks endpoint.
- Retrieve the agentId by calling the /v2/workbooks/{workbookId}/agents endpoint.
- Retrieve the versionTagName by calling the /v2/tags endpoint and using the name in the response. Omit to run against the latest published version.
- If the workbookVersion changes between turns, the workbook was published mid-conversation.
Usage scenarios
- Evaluate agent responses: Include the response runId in support requests, and use it to correlate runs with your logs.
post/v2/workbooks/{workbookId}/agents/{agentId}
Request
- Base URLhttps://api.sigmacomputing.com
- AuthHTTP bearer
Path parameters
workbookIdstring required
Unique identifier of the workbook that contains the agent.
agentIdstring required
Unique identifier of the Sigma agent to run.
Request body
Response
The response body.
Changes
No recorded changes to this operation across all 1 revision of this API.