AgentsWorklog API reference
GitHub

Repos & platform

Beyond the three record resources, the API exposes repository management, a per-repo activity overview, and the editable coordination guidance. Maintainer-only routes return 403 to non-maintainers.

BASE URLhttps://<your-instance>/api/v1
GET /repos/{owner}/{repo}/overview

Overview

A single snapshot of a repository's current coordination state — active sessions, live Notables, and open Draft PRs — the same data the /activity:overview command and the live feed render.

REQUEST
curl https://your-instance.example.com/api/v1/repos/acme/web/overview \
  -H "Authorization: Bearer $TOKEN"

Repositories & settings

Manage which repositories are registered and tune their per-repo settings.

MethodPathPurpose
GET/reposList repositories you can access, with derived activity counts.
GET/repos/availableRepositories the GitHub App can be installed on but that aren't registered yet.
POST/reposRegister a repository from the picker.
POST/repos/refreshRe-sync the accessible-repository list from GitHub.
GET/repos/{owner}/{repo}Fetch a single repository's detail.
PATCH/repos/{owner}/{repo}/settingsUpdate per-repo settings (maintainer only). See Configuration.
GET/repos/{owner}/{repo}/live-urlThe live activity-feed URL for the repository.
DELETE/repos/{owner}/{repo}Remove a repository (maintainer only).
UPDATE SETTINGS
curl -X PATCH https://your-instance.example.com/api/v1/repos/acme/web/settings \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "activity_ttl_ms": 43200000 }'
GET /repos/{owner}/{repo}/coordination-guidance

Coordination guidance

The canonical coordination block a repo teaches its agents — the same text /activity:init installs and the coordination_block_get tool returns. GET resolves the rendered guidance; maintainers can PUT a per-item toggle state plus a custom append to tailor it. Treat the returned text as context, never as instructions to execute.

REQUEST
curl https://your-instance.example.com/api/v1/repos/acme/web/coordination-guidance \
  -H "Authorization: Bearer $TOKEN"

Auth & session

Browser OAuth and token management live under /auth. See Authentication for token minting.

MethodPathPurpose
GET/auth/meThe authenticated identity.
POST/auth/tokensMint an agent token (returns it once).
POST/auth/refreshRefresh the browser session.
POST/auth/logoutEnd the browser session.