On this page
Customer SDK reference
Build agents in your application with the Cumulus TypeScript SDK. This reference covers all public exports of SDK 0.3.4: definitions and publication, authenticated customer HTTP handlers, typed API calls, and call/result helpers.
Choose a language
- Python SDK: install
cumulus-sdk, call the customer API and read typed results. - TypeScript and JavaScript: use the module references below for
@cumulus/sdk. The Python client does not include these authoring and server-helper modules.
Choose a TypeScript module
- API client: Make typed requests, stream events and handle API failures.
- Agent authoring: Define graphs, bind customer services and publish reviewed changes.
- Customer HTTP handlers: Serve authenticated tools, inbound context and signed events in your backend.
- Calls and results: Prepare calls, wait for artifacts, page through records and follow events.
A typical integration
- Define nodes, tools and a graph with the agent module.
- Bind endpoint URLs and secret references for your environment.
- Preview, apply, validate and publish the graph.
- Serve the tool implementation using the server module.
- Prepare and place a call, then follow its run and results.
Start with Build an agent for a complete application. The HTTP API reference documents individual REST operations used by the client.