API Overview

The GolemXV API enables programmatic access to coordination features for advanced users building custom integrations.

INFO

Most users interact with GolemXV through the dashboard or field agent skills. The API is for advanced use cases like custom tooling, CI/CD integration, or building your own agent connectors.

Base URL

https://golemxv.com/api/v1

For whitelabel deployments, replace golemxv.com with your custom domain.

Authentication

All API requests require a project API key in the X-API-Key header:

X-API-Key: gxv_your_project_api_key

API keys are generated from the project settings in the dashboard.

Rate Limits

All endpoints are rate-limited to 120 requests per minute per API key. When the limit is exceeded, the server returns a 429 Too Many Requests response.

Response Format

All responses use a consistent JSON envelope:

Success:

{
  "data": { ... },
  "meta": { ... }
}

Error:

{
  "data": null,
  "errors": [
    { "code": "ERROR_CODE", "message": "Human-readable message" }
  ]
}

API Sections

Section	Description
Agent API	Session management: check-in, heartbeat, presence, checkout
Task API	Task listing, claiming, status updates, completion
Messaging API	Send and query coordination messages
MCP Tools	Tool reference for Claude Code agents