API

API reference

Every partner path, generated from the OpenAPI document.

This table is generated from the OpenAPI document (OpenAPI 3.0.3, info version 1.0.0). Each operation there has a summary and, when a key is required, the scope name. That document does not yet attach a request body to each operation. Field lists on the topic pages are taken from the handlers.

Embed a Hawkeye agent (for example a Receptionist or Garage Front Desk) over text and phone. Keys are deny-by-default. Usage is billed to the key's account with the existing credit meter.

GET /docs/partner is listed there as the quickstart. That address now redirects to /docs/api/quickstart.

Method	Path	Summary	Scope	Auth
`GET`	`/api/partner/v1/openapi.json`	This document. No key required.	—	No
`GET`	`/docs/partner`	Quickstart page. No key required.	—	No
`GET`	`/api/partner/v1/me`	The key's scopes, agents, rate limit and spend. Any live key.	—	Bearer
`POST`	`/api/partner/v1/conversations`	Start a conversation.	text	Bearer
`GET`	`/api/partner/v1/conversations/{id}`	Read a conversation.	text	Bearer
`POST`	`/api/partner/v1/conversations/{id}/messages`	Send a message. Attach images and PDFs.	text	Bearer
`POST`	`/api/partner/v1/conversations/{id}/messages/stream`	Same message as SSE.	text	Bearer
`POST`	`/api/partner/v1/messages`	Send a message. conversation_id is optional.	text	Bearer
`POST`	`/api/partner/v1/messages/stream`	Streaming send.	text	Bearer
`POST`	`/api/partner/v1/files`	Upload an image or PDF.	files	Bearer
`POST`	`/api/partner/v1/images`	Generate an image.	image	Bearer
`POST`	`/api/partner/v1/videos`	Start a video.	video	Bearer
`GET`	`/api/partner/v1/videos/{id}`	Video status.	video	Bearer
`GET`	`/api/partner/v1/phone-numbers`	Numbers attached to agents.	voice	Bearer
`POST`	`/api/partner/v1/phone-numbers`	Attach an E.164 number or provision a bridge.	voice	Bearer
`DELETE`	`/api/partner/v1/phone-numbers/{id}`	Detach a number.	voice	Bearer
`POST`	`/api/partner/v1/calls`	Place an outbound call.	voice	Bearer
`POST`	`/api/partner/v1/phone/inbound`	Tell Hawkeye an inbound call arrived.	voice	Bearer
`GET`	`/api/partner/v1/calls/{id}`	Call transcript and summary.	voice	Bearer
`POST`	`/api/partner/v1/calls/{id}/turns`	Provider bridge: send one utterance, get the spoken reply.	voice	Bearer
`POST`	`/api/partner/v1/calls/{id}/end`	End a call.	voice	Bearer
`GET`	`/api/partner/v1/voice/stream`	Websocket bridge. Text frames are utterances. Audio uses the provider session.	voice	Bearer
`GET`	`/api/partner/v1/projects`	List projects.	projects	Bearer
`POST`	`/api/partner/v1/projects`	Create a project.	projects	Bearer
`GET`	`/api/partner/v1/tasks`	Queued work.	projects	Bearer
`POST`	`/api/partner/v1/tasks`	Queue a task.	projects	Bearer
`GET`	`/api/partner/v1/agents`	Agents this key may use.	agents	Bearer
`POST`	`/api/partner/v1/agents`	Create an agent. The router chooses the model.	admin	Bearer
`GET`	`/api/partner/v1/tools`	Tools and skills for an agent.	tools	Bearer
`POST`	`/api/partner/v1/tools/invoke`	Run one plugin tool.	tools	Bearer

Attachment schema

Same field as chat and POST /api/v1/chat/completions. data is a base64 data URL. Requires the files (file-upload) scope.

Field	Type	Required
`type`	image, pdf	yes
`name`	string	yes
`mime`	string	yes
`data`	string	yes

Not in this document

POST /api/v1/chat/completions and GET /api/v1/models are the OpenAI-compatible routes. They use the same key and the text scope, and they are not listed in the partner OpenAPI file. See Chat completions.