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

# Introduction

> Tyms is the AI-Native Accounting Platform — integrate books, banking, and reports over a single REST API.

**Tyms** is the AI-Native Accounting Platform for small and medium-sized businesses across service, consulting, retail, and manufacturing. It automates bookkeeping workflows, understands natural language, and keeps financial data consistent with what business owners see in the product.

The **Tyms Developer API** is a REST surface on a single base URL so you can integrate Tyms 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 Tyms’s **Developer API subscription** rules. Without an active qualifying subscription, protected routes return **403 Forbidden**.

## Who this documentation is for

> **Business integrators**
>
> 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.

> **Partners**
>
> **Referral business partners** (distributors) who onboard **new** Tyms businesses and may grant Plus or credits from partner holding. You use a **partner** key for routes under **API reference** → **Partners**, then each business’s **secret key** for all other endpoints.

## 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](https://developer.tyms.io/api-reference/attachments.md)).
* **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** Tyms reports ([Income statement](https://developer.tyms.io/api-reference/reports/income-statement.md) and sibling endpoints under **Reports**).

## Environments

The Developer API runs in **production** and **sandbox**. Paths, request bodies, and headers are the same in both environments — only the **host** and your **API keys** change.

| Environment | Base URL | Use for |
| - | - | - |
| **Production** | `https://api.usetyms.com/v1/adam` | Live businesses and real financial data |
| **Sandbox** | `https://staging-api.usetyms.com/v1/adam` | Pre-production integration and testing |

> [!NOTE]
>
> **Sandbox access is not self-service.** Email [developer@usetyms.com](mailto:developer@usetyms.com) to request a sandbox account and credentials before calling the staging host. Sandbox keys work **only** on the sandbox base URL; production keys from the Tyms app work **only** on production.

All paths in this reference are relative to the base URL for the environment you are using. Example: `GET /auth/validate` on production is `https://api.usetyms.com/v1/adam/auth/validate`; on sandbox it is `https://staging-api.usetyms.com/v1/adam/auth/validate`.

## Where to go next

> **[Quickstart](https://developer.tyms.io/quickstart.md)**
>
> Validate a key and send your first request in minutes.

> **[Concepts](https://developer.tyms.io/concepts.md)**
>
> How AI creates, async vs direct processing, and how reports relate to the product.

> **[Authentication](https://developer.tyms.io/authentication.md)**
>
> Business keys, partner keys, headers, and subscription expectations.

> **[OAuth 2.0](https://developer.tyms.io/oauth.md)**
>
> Connect Tyms users to your integration app without sharing secret keys.

> **[API reference](https://developer.tyms.io/api-reference/overview.md)**
>
> Complete endpoint documentation lives under the **API reference** tab — start from the overview.

> **[MCP and AI](https://developer.tyms.io/mcp/overview.md)**
>
> Connect Claude or ChatGPT to your Tyms business with the hosted MCP server — no local package to install.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.