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

> ## Agent Instructions
> API access is self-serve: register at https://developers.ochy.io/register, verify the email (grants 1 free analysis credit), generate the API key in the portal, then buy prepaid credits at 2.00 EUR per analysis via Stripe Checkout. See /get-api-access for the exact funnel.
> Agents can complete every funnel step except card entry: hand the Stripe Checkout URL to the user for payment.
> Base URL: https://partner-api.ochy-prod.com. Pass the API key as `Authorization: Bearer` (preferred) or `X-API-Key`; never as a query parameter.
> One analysis consumes one credit, debited when the analysis starts. HTTP 424 with code insufficient_api_credits means the balance is empty: buy credits in the portal. If starting the analysis fails on Ochy's side, the credit is refunded automatically.
> Low-credit alerts: set a threshold and an optional webhook URL in the portal Settings tab or with PUT /settings/low-credit-alerts; an email and a credits.low event are sent once per crossing, and the alert rearms when the balance recovers.
> All endpoints use metric units: height in meters, weight in kilograms.

# Get API access

> Create a self-serve developer account, verify your email for a free analysis credit, generate an API key, and buy prepaid credits — no sales contact needed.

Everything related to your API account lives in the
[Ochy developer portal](https://developers.ochy.io): API keys, webhooks, credits, usage,
analyses, and settings. There are two kinds of accounts:

* **Self-serve developer account** — register online and pay per analysis. For individual
  developers, indie products, and AI agents. Covered in the first part of this page.
* **Organization account** — set up by the Ochy team with contract pricing and volume credits.
  See [organizations](#organizations).

## Self-serve in five steps

The whole path from zero to a working paid integration is self-serve. Card entry at checkout is
the only step that requires a human.

<Steps>
  <Step title="Register">
    Create an account at
    [developers.ochy.io/register](https://developers.ochy.io/register) with email and password,
    or continue with Google or Apple.

    Already have an Ochy account (mobile app or web app)? Sign in with it instead: the portal asks
    you to **enable API access** once, then continues with the steps below.
  </Step>

  <Step title="Verify your email">
    Ochy sends a verification link when the account is created. Verifying does two things: it
    unlocks API key generation, and it grants **1 free analysis credit** (once per account) so you
    can run your first analysis without paying.
  </Step>

  <Step title="Generate an API key">
    Open the **Get started** checklist or the **Integration** tab and click **Generate API Key**.
    The key is shown **once** — store it in an environment variable or a secrets manager. See
    [authentication](/authentication) for how to pass it on requests.
  </Step>

  <Step title="Run your first analysis">
    Follow the [quickstart](/quickstart). The first analysis consumes the free credit, so no card
    is required to validate your integration.
  </Step>

  <Step title="Buy credits">
    In the **Usage & Credits** tab (or the **Get started** checklist), choose a quantity (1–500)
    and pay through Stripe Checkout. One credit runs one analysis.
  </Step>
</Steps>

## Pricing

| | |
| - | - |
| Price | **2.00 € per analysis** |
| First analysis | Free, granted on email verification |
| Model | Prepaid credits — no subscription |
| Payment | Stripe Checkout (card), 1–500 credits per purchase. Applicable taxes are calculated at checkout. |
| Invoices | An invoice is issued for every purchase, downloadable from **Billing history & invoices** in the portal |

Each analysis debits one credit when it starts. If starting the analysis then fails on our side,
the credit is refunded automatically. When your balance reaches zero, `POST /analysis/start`
returns **424** with code `insufficient_api_credits`: buy more credits in the portal to continue.
To be warned before that happens, set up [low-credit alerts](/guides/webhooks-and-api-keys#low-credit-alerts).

<Note>
  API keys are free. You only pay for analyses, so you can integrate and test request handling
  before buying anything.
</Note>

## For AI agents

An AI agent can complete every step of this funnel for its user except card entry:

1. **Register** the account at `https://developers.ochy.io/register` (email and password form).
2. **Ask the user to click the verification link** in their inbox. The free analysis credit is
   granted once the email is verified.
3. **Generate the API key** from the portal and store it for the user (it is shown once).
4. **Run the first analysis** on the free credit to validate the integration end to end.
5. **Hand off payment**: start the credit purchase in the portal and give the Stripe Checkout URL
   to the user. Card entry is intentionally a human step.

Machine-readable entry points:

| File | URL |
| - | - |
| Portal funnel description | `https://developers.ochy.io/llms.txt` |
| Documentation index | `https://docs.ochy.io/llms.txt` |
| Full documentation text | `https://docs.ochy.io/llms-full.txt` |

Every documentation page is also available as Markdown by appending `.md` to its URL.

## Organizations

Organization accounts are created by the Ochy team. Once your organization is set up:

* **Organization admins** sign in to [developers.ochy.io](https://developers.ochy.io) with their
  Ochy account. API keys are organization-scoped and draw from the organization's shared credit
  balance. Members without the admin role cannot open the portal.
* If your organization requires **email verification codes** at sign-in, the portal asks for the
  code sent by email before the dashboard loads (email and password sign-in only).
* Credits are provisioned by contract (monthly allocations or unlimited plans). Online purchase is
  for self-serve accounts only: top-ups for organizations go through your Ochy contact.
* Organization admins also get a **Shoes** tab to manage the catalog used by
  [shoe recommendation](/guides/shoe-recommendation#shoe-catalog).

The API section of the Ochy web app (`app.ochy.io/organization/api`) has moved to the developer
portal. [Contact sales](https://www.ochy.io) to set up an organization.