---
title: "Try the API"
description: "Send live KingMinos API requests from the docs. Paste a key, pick an endpoint, set every parameter, read the response. Your key stays in your browser."
canonical: "https://kingminos.com/docs/api/try/"
sourceKind: "source-mdx"
---

import ApiTryIt from '../../../../components/docs/ApiTryIt.astro';

Test the KingMinos API against production without leaving the docs — no `curl`, no Postman, no separate console. The health check below is already selected and needs no key, so hit **Send request** to see it work.

<ApiTryIt />

## Health checks vs. account endpoints

The dropdown has two groups:

- **No key required** — `GET /health` answers "is KingMinos up?" Anyone can run it, which is what you just did. The OpenAPI document routes are here too.
- **API key required** — the provider registry and capability catalog, the capability decisions (`company.resolve`, `company.b2b-social`, `company.x-account`, `company.icon`, `company.description`, `company.domain`, `company.hierarchy`, `person.verify-employment`, `person.language`, `person.phone`, `person.title`, `person.name`, `person.b2b-social`), runs, recipes, vendor keys, feedback, and webhooks (`/v1/webhooks*`, `/v1/events`). Sign in at [app.kingminos.com](https://app.kingminos.com/login/) to mint a `km_` user token, or use a tenant key (`osr_`). See [Authentication](/docs/api/authentication/).

Account routes (`/v1/account*`, `/v1/auth/*`) need a signed-in session, so they are only in the console inside the app at [app.kingminos.com/app/try/](https://app.kingminos.com/app/try/).

Both groups come from the live [OpenAPI document](https://api.kingminos.com/openapi.json), so the menu matches whatever the live spec lists. For the full contract, see [Endpoints](/docs/api/).

## Parameters, bodies, and credits

Every parameter the spec declares gets its own input — path, query, and headers (`X-Router-Explain`, `X-Router-Schema`, `Idempotency-Key`, …), with required ones marked. Operations with a JSON request body get a body editor seeded from the OpenAPI example.

Capability calls run the real vendor waterfall and **spend credits unless `dry_run` is true**. Every verified work-email account gets 10 free credits a day (unused credits expire at midnight UTC); see [Pricing](https://kingminos.com/pricing/) for eligibility and how balances work. The console seeds capability bodies with `"dry_run": true` — delete that flag to run live. `DELETE` asks for confirmation. Storing a vendor key (`PUT /v1/credentials/{provider}`) encrypts it and never echoes it. `DELETE /v1/subjects/{subject_key}` erases a subject and needs the `erase` key scope. Webhook routes need a key minted with the `webhooks` scope (tick **Can manage webhooks** on the API tokens page) and webhooks enabled on the workspace; webhook secrets are shown once on create and rotate.

## How your API key is handled

Paste a key and here is exactly what happens to it:

- **It stays in this browser tab.** The key lives in the tab's `sessionStorage`. Close the tab and it is gone; clear the field and it is removed at once. It is never written to a cookie, saved to a database, or sent to this docs site.
- **It goes straight to the API.** Requests run from your browser to `https://api.kingminos.com` over HTTPS with the key in the `Authorization` header — the same call your own code makes. Nothing is proxied through this docs site.

Use a low-scope key for exploration, avoid shared machines, and revoke the key if it is ever exposed.

## Related

- [Endpoints](/docs/api/)
- [Authentication](/docs/api/authentication/)
- [Vendor keys](/docs/api/credentials/)
- [Company resolve](/docs/api/company-resolve/)