API reference

The complete Polylane API reference is hosted alongside the platform itself:

Authentication

Authenticate requests with one of:

• x-api-key: <api-key> for workspace API keys.
• Authorization: Bearer <access-token> for OAuth access tokens.

Create API keys and register OAuth clients in the console. See API keys and OAuth.

curl https://api.polylane.com/v1/workspaces \
  -H "x-api-key: $POLYLANE_API_KEY"

Response format

Every JSON response uses the same envelope. Successful responses set success: true and put the payload under result:

{
  "success": true,
  "message": { "message": "Successful request" },
  "error": null,
  "result": { "items": [], "count": 0 }
}

Error responses set success: false and describe the failure under error:

{
  "success": false,
  "message": null,
  "error": { "message": "Unauthorized", "detail": "Invalid API key" }
}

From the command line

Every API operation is callable from the Polylane command line interface (CLI), including operations without a first-class command:

polylane api list                         # every operation
polylane api describe workspaces.list     # request and response shape
polylane api call issues.list --query '{"active":true,"severity":"critical"}'

polylane api call accepts --body '<json>' for request bodies, --body-file <path> to read a body from a file, and --query '<json>' for query parameters.

The CLI client is generated from the same OpenAPI specification as the hosted reference, so every operation you find there is directly callable. Authenticate it with an API key via polylane auth login --api-key sk_..., or run polylane auth login for the browser flow. See CLI authentication.