Orchly API

Pull your AI visibility, organic search, rankings, shopping, and AI traffic data out of Orchly programmatically. Anything you see in the app, you can fetch with the API.

Pick an endpoint from the sidebar, or start with the basics below.

Authentication

Create an API key in the Orchly app under your API Keys settings, then send it with every request as a Bearer token:

curl https://app.orchly.ai/api/v1/validate \
  --header 'Authorization: Bearer obk_live_xxx'

You can also send it in an X-API-Key header. Call Validate API key first to confirm a key works and see which workspaces it can reach.

Base URL

https://app.orchly.ai/api/v1

Choosing a workspace

Most endpoints are scoped to one workspace. Pass it with the X-Workspace-Id header (or a workspace_id query parameter). Get your workspace ID from workspace settings.

Responses

Successful responses return JSON. Errors return an error object with a machine-readable code, a human message, and optional details:

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key cannot write content.",
    "details": {}
  }
}

Rate limits

Requests are limited per organization, per hour. Every response includes RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset headers. Going over returns 429 with a Retry-After header.

The full OpenAPI spec is available to download.