Andy Developer Docs

Andy Developer Docs

The canonical guide to Andy's public lifecycle for humans and agents.

Create a Workspace and Agent, give the Agent reviewed Knowledge, and expose it through Public Chat or the React Widget. The Tenant Operation catalog is the common source for andy-partner, HTTP, and the App. MCP exposes its explicitly closed, job-oriented projection of selected operations.

Start with the Quickstart. Use Authentication for User login and scoped Workspace API Keys, then continue to Workspaces and Agents, Knowledge, or Widget. For the authenticated product surface and its read-only assistant, use Andy App Support. To connect and verify a professional Instagram account, use Instagram Messaging.

When to use Andy

Use Andy when you need to operate an Andy Workspace, Agent, Knowledge Source, Public Chat, Widget, or Content Engine through a deterministic typed interface for a human or an agent. Each capability is one Tenant Operation. The App, HTTP, and CLI use the catalog directly, while MCP publishes its closed job-oriented projection in mcp-v2.ts. If you are automating or prompting Andy, use the interface that matches your client.

Discovery

Andy exposes its machine interfaces at a single source of truth per reader:

  • OpenAPI 3.1 — the canonical typed document for every HTTP-exposed Tenant Operation, generated from the operation catalog: https://app.andypartner.com/api/openapi/tenant-operations
  • MCP endpoint — JSON-RPC 2.0 over streamable HTTP: https://app.andypartner.com/api/mcp
  • RFC 9728 protected-resource metadata — OAuth discovery for MCP: https://app.andypartner.com/.well-known/oauth-protected-resource/api/mcp
  • npm CLIandy-partner (andy), the same catalog-backed operations from the terminal
  • Authentication/authentication for User login and scoped Workspace API Keys
  • Support/support for the public developer contract

Andy publishes explicit Markdown at the matching .md URL for every page. Machine readers can discover the complete corpus through /llms.txt, /llms-full.txt, and /agent-readability.json. The apex site (andypartner.com) points at the canonical docs and the OpenAPI document from its own /llms.txt.

Public documentation covers only the released tenant contract. Billing, migrations, evaluations, dogfood controls, Platform Admin, and internal operator workflows are not public operations.

On this page