Everything importable from aura_sdk, generated from the package’s own docstrings — help() on any of
these prints the same text.
The request and response models the methods return live in aura_sdk.models, generated from the
backend’s OpenAPI spec. Their fields are documented by the REST reference, under the
operation that returns them.
| Class |
Description |
| AuraApiError |
The Aura API returned a non-2xx response. |
| AuraClient |
Async client for the Strangeworks Aura public /api/v1 surface. |
| AuraError |
Base class for every error this SDK raises. |
| AuraResponseError |
The server answered, but with something this SDK could not read. |
| AuraTurnCancelledError |
An agent turn was cancelled before it finished. |
| AuraTurnTimeoutError |
A turn did not finish within the wait timeout. |
| DeploymentFiles |
A published deployment’s files: the model and data a project starts from. |
| SnapshotFiles |
One run’s captured state. Immutable: the server rejects writes to it. |
| ToolActivityData |
One tool starting, completing, or failing during the turn. |
| WorkspaceFiles |
One project’s live files — the deployment’s, plus whatever the agent wrote. |
| Type alias |
Description |
| FileContainer |
Which files an operation targets: a DeploymentFiles, WorkspaceFiles or SnapshotFiles. |
| Region |
The two Aura deployments. A key minted in one region is not valid in the other. |
| WebSocketFactory |
Opens the project event socket. |
| Constant |
Description |
| BASE_URL_BY_REGION |
Each region’s API host — the base_url that region is shorthand for. |
| DEFAULT_BASE_URL |
The EU API host, https://aura-api-eu.strangeworks.com. |
| DEFAULT_REGION |
The region a client talks to when neither region nor base_url is given. |
