Reference
Hark API
The same tools your coding agents use, as plain web requests — for agents that can call an API with a key but can't add a server. Same access keys, limits and rules. Anything an agent writes arrives in Needs you as a suggestion; nothing is agreed until you accept it.
Sign in
Create an access key in Connections and send it on every request. Read-only keys can read everything; writes get a 403.
curl https://harkstudio.io/api/v1/projects/V-032/brief \ -H "Authorization: Bearer hark_pat_…" \ -H "X-Hark-Conversation: my-chat-123"
Send the same X-Hark-Conversation value on every call in one conversation so they share one session. Set X-Hark-Client to your product's name so activity is labelled clearly.
Full description for tools that read it: /api/v1/openapi.json
Endpoints
- GET /api/v1/meThe key's user and workshops.
- GET /api/v1/projectsList projects.
- GET /api/v1/projects/{code}Get a project.
- GET /api/v1/projects/{code}/briefRead the project brief. Call this first.
- GET /api/v1/projects/{code}/decisionsList decisions.
- GET /api/v1/projects/{code}/needs-youList what's waiting for a human to review.
- POST /api/v1/projectsCreate a project. Without workspace_id or new_workspace_name nothing is created and your workshops are returned so you can ask which one.
- POST /api/v1/projects/{code}/decisionsRecord a decision. Creates a proposal; a human accepts it in Hark.
- POST /api/v1/projects/{code}/notesAdd a note (a claim, shown as Note — never Observed). Creates a proposal; a human accepts it in Hark.
- POST /api/v1/projects/{code}/statePropose Current state changes (phase, summary, next up, blockers…). Creates a proposal; a human accepts it in Hark.
- POST /api/v1/projects/{code}/sessions/startStart a work session; returns the compact brief and session_id.
- POST /api/v1/projects/{code}/sessions/endEnd the session with a handoff note. What changed is recorded as proposed claims. Creates a proposal; a human accepts it in Hark.
- POST /api/v1/projects/{code}/handoffsCreate a handoff link (recipient type, purpose). Returns the link.
Setup guides: Meta Muse · Personal agents