Reference
API reference
Where the hosted OpenAPI reference lives, how to authenticate, what every response looks like, and the rate limits.
The complete Polylane API reference is generated from the OpenAPI specification the platform serves, so it always matches what is deployed.
Authentication
Send a workspace API key in the x-api-key header, or an OAuth access token in Authorization: Bearer. Create either in the console; see API keys and OAuth clients.
Terminal
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Response format
Every JSON response uses the same envelope.
| Field | Description |
|---|---|
success | true when the request succeeded, false when it failed. |
message | On success, an object whose message describes the status. null on failure. |
error | null on success. On failure, an object with a message, an optional detail and optional metadata. |
result | The payload on success. Absent on failure. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Rate limits
| Surface | Limit |
|---|---|
| REST API | 5,000 requests per 60 seconds per credential |
| Platform MCP server | 600 requests per 60 seconds per credential |
Responses advertise the policy in the RateLimit-Limit and RateLimit-Policy headers. Over the limit, the API answers 429 with a Retry-After header carrying the window in seconds; back off until it elapses, then retry.
Every operation is also callable from the CLI, which is generated from the same specification.
Related
- API keys and OAuth clients to create the credentials these requests use.
- CLI to call the API from a terminal or a script.
- Platform MCP server to reach the same data from an editor agent.