API

API overview

Scoped keys, the partner API, and chat completions.

Two HTTP surfaces take a personal API key. The partner API embeds an agent you already run (a Receptionist or a Garage front desk, for example). POST /api/v1/chat/completions is the OpenAI-compatible chat endpoint for the same key.

The machine-readable partner description is /api/partner/v1/openapi.json. The old quickstart address /docs/partner redirects to the quickstart.

Start here

• Create a scoped key
• Send a message in a few minutes
• Every partner path, from the OpenAPI document
• curl, JavaScript, and Python snippets

There is no published Hawkeye SDK. The snippets call the HTTP API directly. POST /v1/chat/completions is a different route: it uses the account proxy token inside an agent, not a personal API key.