> ## Documentation Index
> Fetch the complete documentation index at: https://developer.usetyms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Adam is the AI accounting agent behind useadam.io — integrate books, banking, and reports over a single REST API.

**Adam** is the AI accounting agent for small businesses on [useadam.io](https://useadam.io). It automates bookkeeping workflows, understands natural language, and keeps financial data consistent with what business owners see in the product.

The **Developer API** is a REST surface on a single base URL so you can integrate Adam into your own stack, marketplaces, or automation tools (Zapier, Make, internal ETL, partner onboarding flows, and more).

<Warning>
  The Developer API is available when your business meets Adam’s **Developer API subscription** rules. Without an active qualifying subscription, protected routes return **403 Forbidden**.
</Warning>

## Who this documentation is for

<CardGroup cols={2}>
  <Card title="Business integrators" icon="building">
    Product and engineering teams connecting **their** Tyms business to internal tools, billing systems, or workflows. You use the business **secret key** (`tyms_sk_...`) from Settings → API.
  </Card>

  <Card title="Partners" icon="handshake">
    **Referral business partners** (distributors) who onboard **new** Tyms businesses and may integrate on the owner’s behalf. You use a **partner** key for [Register business](/api-reference/register-business) only, then each business’s **secret key** for all other endpoints.
  </Card>
</CardGroup>

## What you can build

* **AI-assisted creates** — Invoices, bills, expenses, income, journals, contacts, chart-of-accounts lines, and **bank statement lines** from prompts plus optional files (see [Attachments](/api-reference/attachments)).
* **CRUD and reads** — List, get, update, and delete the same record types the app manages, scoped to one business per key.
* **Banking** — List banks and bank transactions; upload and categorize activity through the same AI-assisted pipeline as the app.
* **Financial reports** — Income statement, balance sheet, trial balance, and cash flow aligned with **in-app** Adam reports ([Income statement](/api-reference/report-income-statement) and sibling endpoints under **Reports**).

## Base URL

All paths in this reference are relative to:

```
https://api.useadam.io/v1/adam
```

## Where to go next

<Columns cols={2}>
  <Card title="Quickstart" icon="bolt" href="/quickstart">
    Validate a key and send your first request in minutes.
  </Card>

  <Card title="Concepts" icon="book-open" href="/concepts">
    How AI creates, async vs direct processing, and how reports relate to the product.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Business keys, partner keys, headers, and subscription expectations.
  </Card>

  <Card title="OAuth 2.0" icon="link" href="/oauth">
    Connect Tyms users to your integration app without sharing secret keys.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference/overview">
    Complete endpoint documentation lives under the **API reference** tab — start from the overview.
  </Card>
</Columns>