Documentation Index
Fetch the complete documentation index at: https://docs.alterauth.com/llms.txt
Use this file to discover all available pages before exploring further.
Alter ships two backend SDKs (Python, TypeScript) and one optional browser SDK (Connect.js). Backend SDKs are surface-parity — same method names (snake_case vs camelCase), same exception hierarchy, same models.
Pick a language
| Language | Package | Install |
|---|
| Python | alter-sdk (PyPI) | pip install alter-sdk |
| TypeScript / Node | @alter-ai/alter-sdk (npm) | npm install @alter-ai/alter-sdk |
| Browser (popup) | @alter-ai/connect (npm) | npm install @alter-ai/connect |
create_connect_session().
Pick a class — App or Agent
Both backend SDKs expose two top-level classes. The constructed class decides the principal kind at runtime.
| Class | API key prefix | Use when |
|---|
App | alter_key_app_… | One backend service. Operator code. Anything that’s not a named agent. |
Agent | alter_key_agent_… | A named, operator-provisioned workload (chat agent, MCP server, background worker). |
Agent instances on top of App.
The one-line example
This is what application code looks like after the quickstart:
from alter_sdk import App, HttpMethod
vault = App(api_key=ALTER_API_KEY)
response = await vault.request(HttpMethod.GET, url, grant_id=GRANT_ID)
Reference
Both languages have an identical 8-page reference. Pick a language; the page split is the same:
| Page | Covers |
|---|
| Client | App, Agent, lifecycle |
| Request | request, proxy_request, boto3_client (Python only) |
| Grants | list_grants, create_managed_secret_grant, revoke_grant, revoke_delegation |
| Connect | connect, authenticate, create_connect_session, verify_user_token |
| Agents | App.get_agent, App.agents.*, Agent.me, Agent.trace |
| Approvals | get_approval_status, await_approval |
| Errors | Exception hierarchy + retry guidance |
| Types | Principal union, Grant, Context, dataclasses |
Framework integrations
The Python SDK ships first-party integrations:
TypeScript framework integrations land in upcoming releases.
See also
