Skip to content
Aura
Search
Ctrl
K
Cancel
Open Aura
Select theme
Dark
Light
Auto
Start here
Quickstart
Core concepts
Authentication
Guides
Deploy a model
Instructions and skills
Chat with a project
Read results
Snapshots and tags
Bring your own dashboard
Usage and credits
Errors
CLI
Overview
Init & config
Skill
Deployment
Project
Snapshot
Workspace
Conversation
Chat session
Dashboard
Usage
TypeScript SDK
Overview
Configuration
Conventions
API reference
Classes
AuraApiError
AuraClient
AuraConnectionError
AuraError
AuraResponseError
AuraTurnCancelledError
AuraTurnTimeoutError
Interfaces
AuraClientOptions
ChatTurnOptions
DeployFromFolderOptions
SendChatOptions
StreamDeltaEvent
StreamEndEvent
StreamErrorEvent
StreamStartEvent
ToolActivityData
ToolActivityEvent
UsageWindow
Type Aliases
AuraRegion
AuraStreamEvent
Variables
BASE_URL_BY_REGION
DEFAULT_BASE_URL
DEFAULT_REGION
Functions
contentTypeForPath
deployFromFolder
Python SDK
Overview
Configuration
Conventions
API reference
Overview
Classes
AuraApiError
AuraClient
AuraError
AuraResponseError
AuraTurnCancelledError
AuraTurnTimeoutError
DeploymentFiles
SnapshotFiles
ToolActivityData
WorkspaceFiles
Functions
content_type_for_path
deploy_from_folder
Type aliases
FileContainer
Region
WebSocketFactory
Constants
BASE_URL_BY_REGION
DEFAULT_BASE_URL
DEFAULT_REGION
API reference
Overview
deployments
List Deployments
GET
Create Deployment
POST
Get Deployment
GET
Delete Deployment
DELETE
Check Deployment
POST
Get Deployment Instructions
GET
Put Deployment Instructions
PUT
Remove Deployment Instructions
DELETE
List Deployment Skills
GET
Get Deployment Skill
GET
Put Deployment Skill
PUT
Remove Deployment Skill
DELETE
files
Batch Delete
POST
Batch Move
POST
Content
POST
Delete File
POST
Download
POST
List Files
POST
Make Directory
POST
Move File
POST
Serve Raw
GET
Plan Upload
POST
Abort Upload
POST
Upload Body
PUT
Complete Upload
POST
Zip Files
POST
projects
List Projects
GET
Create Project
POST
Get Project
GET
Delete Project
DELETE
Update Project
PATCH
Pull Agent Config
POST
Get Project Instructions
GET
Put Project Instructions
PUT
Remove Project Instructions
DELETE
List Project Skills
GET
Get Project Skill
GET
Put Project Skill
PUT
Remove Project Skill
DELETE
chat
Get Agent Status
GET
Cancel Agent
POST
Get Chat History
GET
Post Chat
POST
Clear Chat
DELETE
Get Chat Sync
GET
Get Conversation Debug Bundle
GET
Get Tool Executions
GET
Get Recent Tool Failures
GET
conversations
List Conversations
GET
Create Conversation
POST
Delete Conversation
DELETE
Rename Conversation
PATCH
Activate Conversation
POST
dashboard
Run Dashboard Command
POST
Restart Dashboard
POST
Mint Ticket
POST
snapshots
List Snapshots
GET
Create Manual Snapshot
POST
Get Snapshot
GET
Rename Snapshot
PATCH
solve
List Executions
GET
Get Execution
GET
Delete Execution
DELETE
snapshot-tags
List Snapshot Tags
GET
Get Snapshot Tag
GET
Set Snapshot Tag
PUT
Delete Snapshot Tag
DELETE
workspace
Get Workspace State
GET
Checkout Workspace
POST
usage
Get Company Usage
GET
List Usage By Api Key
GET
List Usage By User
GET
Open Aura
Select theme
Dark
Light
Auto
AuraRegion
type
AuraRegion
=
"
eu
"
|
"
us
"
;
A key minted in one region is not valid in the other.
