Skip to content
General Augment Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start Here
Overview
Agent-Friendly Docs
Quickstart
Concepts
Architecture
Guides
Add Chat to Your App
Coding Agent Prompt
Local Testing
API Stability
Status and Readiness
Roadmap and Intake
Connect Your API
Configure Tools
Write Personality
Identity Linking
Security
Prompt Injection
Support
Channels
BYO Local Connectors
iMessage Mac Connector
Telegram
WhatsApp
SMS
CLI
Installation
Commands
Configuration
SDKs
SDK Reference
API Reference
Overview
admin
Costs
GET
Usage
GET
List Api Keys
GET
Create Api Key
POST
Revoke Api Key
DELETE
Update Api Key
PATCH
Get Current Admin
GET
List Projects
GET
Create Project
POST
Create Project From Config
POST
Get Project
GET
Update Project
PATCH
List Project Approvals
GET
Approve Project Approval
POST
Deny Project Approval
POST
Archive Project
POST
List Project Tool Call Audit
GET
Create Billing Checkout Session
POST
Get Project Credit Balance
GET
Get Project Credit Auto Top Up Settings
GET
Update Project Credit Auto Top Up Settings
PUT
List Project Credit Auto Top Up Attempts
GET
Create Project Credit Grant
POST
Create Billing Credit Top Up Checkout Session
POST
List Billing Events
GET
Create Billing Portal Session
POST
Get Project Channel Status
GET
Get Project Config
GET
Update Project Config
PUT
Export Project Data
GET
List Project Identity Links
GET
Create Project Test Identity Link
POST
Get Project Integration Prompt
GET
Get Project Local Connector Status
GET
Check Project Local Connector Health
POST
List Project Logs
GET
List Project Mcp Servers
GET
Add Project Mcp Server
POST
Delete Project Mcp Server
DELETE
Test Project Mcp Server
POST
List Project Model Providers
GET
Upsert Project Model Provider
PUT
Revoke Project Model Provider
DELETE
Check Project Model Provider Health
POST
Get Project Observability
GET
Get Project Observability Support Bundle
GET
List Project Agent Runs
GET
Get Project Agent Run
GET
Get Project Runtime Policy
GET
List Project Scheduled Jobs
GET
Create Project Scheduled Job
POST
Get Project Scheduled Job
GET
Delete Project Scheduled Job
DELETE
Dispatch Project Scheduled Job
POST
Pause Project Scheduled Job
POST
Resume Project Scheduled Job
POST
List Project Scheduled Job Runs
GET
List Project Skills
GET
Add Project Skill
POST
Get Project Skill
GET
Update Project Skill
PUT
Delete Project Skill
DELETE
Get Project Soul
GET
Update Project Soul
PUT
Test Agent
POST
Replace Project Tools
PUT
Register Project Tools From Openapi
POST
Get Project Trace
GET
Get Project Usage Detail
GET
List Users
GET
Get User Detail
GET
Delete User
DELETE
List Tools
GET
telegram-channel
Connect Telegram
POST
Disconnect Telegram
POST
Telegram Status
GET
Test Telegram
POST
Connect Telegram
POST
Disconnect Telegram
POST
Telegram Status
GET
Test Telegram
POST
agent
Memory Profile
GET
Search Memory
POST
Store Memory
POST
Purge User Memory
DELETE
Delete Memory
DELETE
Send Agent Message
POST
integrations
Link User
POST
Create Magic Link
POST
Resolve Identity
GET
Unlink Identity
DELETE
Create Verification Code
POST
Verify Identity
POST
api-keys
List Api Keys
GET
Create Api Key
POST
Revoke Api Key
DELETE
Update Api Key
PATCH
gateway
Receive Sms Webhook
POST
Receive Telegram Webhook
POST
Verify Whatsapp Webhook
GET
Receive Whatsapp Webhook
POST
billing
Receive Stripe Webhook
POST
auth
Google Oauth Callback
GET
Start Google Oauth
GET
health
Detailed
GET
Live
GET
Ready
GET
App Health
GET
responses
Create Response
POST
Pricing
Changelog
GitHub
Select theme
Dark
Light
Auto
Ready
GET
/health/ready
Return the readiness status for infrastructure probes.
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Successful Response
Select media type
application/json