# Ochy Developers Portal

> Self-serve access to the Ochy running gait analysis API. Upload a running
> video, get biomechanical analysis back (scores, metrics, joint angles,
> running style). Pay per analysis — 2.00 EUR each, prepaid credits, no
> subscription. The first analysis is free.

## Documentation (authoritative)

This portal file only covers signup, billing, and where to get a key. The
API itself — endpoints, request fields, webhooks, subjects, shoe
recommendation, and exercises — is documented at https://docs.ochy.io/.

Read these before calling the API:

- Overview for agents: https://docs.ochy.io/llms.txt
- Full documentation text: https://docs.ochy.io/llms-full.txt
- Introduction: https://docs.ochy.io/introduction.md
- Get API access: https://docs.ochy.io/get-api-access.md
- Quickstart: https://docs.ochy.io/quickstart.md
- Authentication: https://docs.ochy.io/authentication.md
- Analysis workflow: https://docs.ochy.io/guides/analysis-workflow.md
- API keys and webhooks: https://docs.ochy.io/guides/webhooks-and-api-keys.md
- API reference index: https://docs.ochy.io/api-reference/analysis/start-analysis.md

Every docs page is also available as markdown by appending `.md` to its URL.

## Self-serve funnel (exact steps)

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

1. **Register** at https://developers.ochy.io/register with email + password
   (or Google/Apple SSO). This creates a self-serve developer account.
2. **Verify the email address** via the link Ochy sends. Verification grants
   1 free analysis credit automatically.
3. **Generate an API key** in the portal (https://developers.ochy.io/,
   Integration tab, or the /get-started checklist). Requires a verified
   email. The key is shown once — store it securely.
4. **Run the first analysis for free** (see request below).
5. **Buy credits** in the portal: Usage & Credits tab, quantity 1–500 at
   2.00 EUR per credit, paid through Stripe Checkout. Agents should hand the
   Stripe Checkout URL to their human for card entry. Invoices are
   downloadable afterwards from the billing portal ("Billing history &
   invoices").

## Calling the API

Base URL: https://partner-api.ochy-prod.com
Auth: `Authorization: Bearer YOUR_API_KEY` (or `X-API-Key: YOUR_API_KEY`)

Start an analysis with `POST /analysis/start` (multipart form: `video` file +
`analysis_type`; one credit per request, video max 30 MB / 10 s):

    curl -X POST "https://partner-api.ochy-prod.com/analysis/start" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -F "video=@running.mp4" \
      -F "analysis_type=side_view"

Returns 202 with a `video_id`; poll `GET /analysis/{video_id}/results`.
`analysis_type` is `side_view` or `back_view`.

When credits run out, requests return HTTP 424 with code
`insufficient_api_credits` — buy more credits in the portal to continue.

## Links

- Portal: https://developers.ochy.io/
- Register: https://developers.ochy.io/register
- Docs: https://docs.ochy.io/
- Docs for LLMs: https://docs.ochy.io/llms.txt