The developer API
Three read-only endpoints, two scopes, bearer authentication, and keys you issue and rotate yourself.
The public API is small and read-only on purpose. It is not a second interface onto the whole product; it exists so that a workspace and its file listing can be read by something you build. Every endpoint is under /api/v1, and every request carries a bearer token.
Base URL
https://hawiagents.com/api/v1The endpoints
| Method | Path | Scope required |
|---|---|---|
| GET | /api/v1/auth | None beyond a valid key. Reports what the key can do. |
| GET | /api/v1/workspaces/{workspaceId} | workspace:read |
| GET | /api/v1/workspaces/{workspaceId}/files | files:read |
Scopes
| Scope | Grants | Used by |
|---|---|---|
workspace:read | Read the workspace this key belongs to. | GET /api/v1/workspaces/{workspaceId} |
files:read | List file metadata for that workspace. | GET /api/v1/workspaces/{workspaceId}/files |
One key, one workspace
A key is issued against a single workspace and is bound to it. Passing any other workspace identifier returns 404, whether or not that workspace exists. There is no key that spans workspaces; if you need to read two, issue two keys.