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
Migrate App Automation
Long-Running Agent Jobs
Integration Examples
Connect Your API
Configure Tools
Write Personality
Identity Linking
Security
Prompt Injection
Support
Channels
Linq and iMessage
Telegram
CLI
Installation
Commands
Configuration
SDKs
SDK Reference
API Reference
Overview
management-auth-v3
Approve Browser Auth
POST
Get Browser Auth Request
GET
Start Browser Auth
POST
Get Management Me
GET
Exchange Installer Token
POST
project-connections-v3
Receive V3 Linq Webhook
POST
Receive V3 Telegram Webhook
POST
List Connection Operations
GET
Show Connection Operation
GET
List Connections
GET
Show Connection
GET
Request Connection Operation
POST
Acknowledge Connection Reconciliation
POST
model-catalog-v3
List Models
GET
management-v3
List Projects
GET
Create Project
POST
Show Project
GET
Delete Project
DELETE
Transfer Project
POST
List Workspaces
GET
Create Workspace
POST
List Workspace Members
GET
Invite Workspace Member
POST
Remove Workspace Member
DELETE
Update Workspace Member
PATCH
project-hosted-tests-v3
Test Project Candidate Agent
POST
project-approvals-v3
List Approvals
GET
Show Approval
GET
Approve
POST
Deny
POST
project-audit-v3
List Audit
GET
project-budget-v3
Show Budget
GET
Set Budget
PUT
project-credentials-v3
List Credentials
GET
Set Credential
PUT
Remove Credential
DELETE
Connect Credential
POST
project-control-plane-v3
Get Desired State
GET
Commit Desired State
POST
Plan Desired State
POST
Get Operation
GET
List Operation Events
GET
Stream Operation Events
GET
Get Operation Plan
GET
List Releases
GET
Get Release
GET
Diff Release
GET
project-evals-v3
List Evals
GET
Create Eval
POST
Show Eval
GET
Run Eval
POST
project-jobs-v3
List Jobs
GET
Create Job
POST
Show Job
GET
Delete Job
DELETE
Pause Job
POST
Resume Job
POST
Run Job
POST
project-releases-v3
Decide Project Release Operation
POST
Rollback Project Release
POST
Promote Project Release
POST
project-runs-v3
List Runs
GET
Show Run
GET
Cancel Run
POST
Pin Run Eval Case
POST
Retry Run
POST
Show Run Trace
GET
Show Run Trace Observation
GET
project-runtime-keys-v3
List Runtime Keys
GET
Revoke Runtime Key
DELETE
Create Runtime Key
POST
Rotate Runtime Key
POST
project-skill-drafts-v3
List Skill Drafts
GET
Create Candidate From Skill Drafts
POST
Show Skill Draft
GET
project-summary-v3
Get Project Summary
GET
project-usage-v3
Show Usage
GET
List Usage Events
GET
project-users-v3
List Users
GET
Link User
POST
Show User
GET
Delete Application User
DELETE
Unlink User
DELETE
List User Memory
GET
Delete All User Memory
DELETE
Delete User Memory Fact
DELETE
Correct User Memory
POST
provider-webhooks-v3
Receive Nango Webhook
POST
billing-v3
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
Resume Response
POST
Pricing
Changelog
GitHub
Select theme
Dark
Light
Auto
Overview
General Augment Agent Platform
0.1.0
Section titled “General Augment Agent Platform 0.1.0”
Information
OpenAPI version:
3.1.0
Operations
Section titled “Operations”
POST
/api/v3/auth/browser/approve
GET
/api/v3/auth/browser/requests/{request_id}
POST
/api/v3/auth/browser/start
GET
/api/v3/auth/me
POST
/api/v3/auth/token
POST
/api/v3/connections/{binding_id}/linq/webhook
POST
/api/v3/connections/{binding_id}/telegram/webhook
GET
/api/v3/projects/{project_id}/connection-operations
GET
/api/v3/projects/{project_id}/connection-operations/{operation_id}
GET
/api/v3/projects/{project_id}/connections
GET
/api/v3/projects/{project_id}/connections/{connection_name}
POST
/api/v3/projects/{project_id}/connections/{connection_name}/operations
POST
/api/v3/projects/{project_id}/connections/{connection_name}/reconciliations
GET
/api/v3/models
GET
/api/v3/projects
POST
/api/v3/projects
GET
/api/v3/projects/{project_id}
DELETE
/api/v3/projects/{project_id}
POST
/api/v3/projects/{project_id}/transfer
GET
/api/v3/workspaces
POST
/api/v3/workspaces
GET
/api/v3/workspaces/{workspace_id}/members
POST
/api/v3/workspaces/{workspace_id}/members
DELETE
/api/v3/workspaces/{workspace_id}/members/{member_id}
PATCH
/api/v3/workspaces/{workspace_id}/members/{member_id}
POST
/api/v3/projects/{project_id}/agents/{agent_ref}/tests
GET
/api/v3/projects/{project_id}/approvals
GET
/api/v3/projects/{project_id}/approvals/{approval_id}
POST
/api/v3/projects/{project_id}/approvals/{approval_id}/approve
POST
/api/v3/projects/{project_id}/approvals/{approval_id}/deny
GET
/api/v3/projects/{project_id}/audit
GET
/api/v3/projects/{project_id}/budget
PUT
/api/v3/projects/{project_id}/budget
GET
/api/v3/projects/{project_id}/credentials
PUT
/api/v3/projects/{project_id}/credentials/{requirement_name}
DELETE
/api/v3/projects/{project_id}/credentials/{requirement_name}
POST
/api/v3/projects/{project_id}/credentials/{requirement_name}/connect
GET
/api/v3/projects/{project_id}/desired-state
POST
/api/v3/projects/{project_id}/desired-state/commits
POST
/api/v3/projects/{project_id}/desired-state/plan
GET
/api/v3/projects/{project_id}/operations/{operation_id}
GET
/api/v3/projects/{project_id}/operations/{operation_id}/events
GET
/api/v3/projects/{project_id}/operations/{operation_id}/events/stream
GET
/api/v3/projects/{project_id}/operations/{operation_id}/plan
GET
/api/v3/projects/{project_id}/releases
GET
/api/v3/projects/{project_id}/releases/{release_id}
GET
/api/v3/projects/{project_id}/releases/{release_id}/diff
GET
/api/v3/projects/{project_id}/evals
POST
/api/v3/projects/{project_id}/evals
GET
/api/v3/projects/{project_id}/evals/{item_id}
POST
/api/v3/projects/{project_id}/evals/{suite_id}/runs
GET
/api/v3/projects/{project_id}/jobs
POST
/api/v3/projects/{project_id}/jobs
GET
/api/v3/projects/{project_id}/jobs/{job_id}
DELETE
/api/v3/projects/{project_id}/jobs/{job_id}
POST
/api/v3/projects/{project_id}/jobs/{job_id}/pause
POST
/api/v3/projects/{project_id}/jobs/{job_id}/resume
POST
/api/v3/projects/{project_id}/jobs/{job_id}/runs
POST
/api/v3/projects/{project_id}/operations/{operation_id}/approval
POST
/api/v3/projects/{project_id}/releases/rollbacks
POST
/api/v3/projects/{project_id}/releases/{release_id}/promotions
GET
/api/v3/projects/{project_id}/runs
GET
/api/v3/projects/{project_id}/runs/{run_id}
POST
/api/v3/projects/{project_id}/runs/{run_id}/cancel
POST
/api/v3/projects/{project_id}/runs/{run_id}/eval-case
POST
/api/v3/projects/{project_id}/runs/{run_id}/retry
GET
/api/v3/projects/{project_id}/runs/{run_id}/trace
GET
/api/v3/projects/{project_id}/runs/{run_id}/trace/observations/{observation_index}
GET
/api/v3/projects/{project_id}/runtime-keys
DELETE
/api/v3/projects/{project_id}/runtime-keys/{key_id}
POST
/api/v3/projects/{project_id}/runtime-keys/{target}
POST
/api/v3/projects/{project_id}/runtime-keys/{target}/rotate
GET
/api/v3/projects/{project_id}/skill-drafts
POST
/api/v3/projects/{project_id}/skill-drafts/candidates
GET
/api/v3/projects/{project_id}/skill-drafts/{draft_id}
GET
/api/v3/projects/{project_id}/summary
GET
/api/v3/projects/{project_id}/usage
GET
/api/v3/projects/{project_id}/usage/events
GET
/api/v3/projects/{project_id}/users
POST
/api/v3/projects/{project_id}/users/links
GET
/api/v3/projects/{project_id}/users/{user_id}
DELETE
/api/v3/projects/{project_id}/users/{user_id}
DELETE
/api/v3/projects/{project_id}/users/{user_id}/links/{provider_name}
GET
/api/v3/projects/{project_id}/users/{user_id}/memory
DELETE
/api/v3/projects/{project_id}/users/{user_id}/memory
DELETE
/api/v3/projects/{project_id}/users/{user_id}/memory/{memory_id}
POST
/api/v3/projects/{project_id}/users/{user_id}/memory/{memory_id}/corrections
POST
/api/v3/webhooks/nango
POST
/api/v3/webhooks/stripe
GET
/auth/google/callback
GET
/auth/google/start
GET
/health/detailed
GET
/health/live
GET
/health/ready
GET
/v1/health
POST
/v1/responses
POST
/v1/responses/{response_id}/resume