API Overview

The Citlyze REST API lets you pull read-only workspace data into BI tools, spreadsheets, scripts, and internal dashboards.

Base URL

API requests go to the Citlyze app host:

https://app.citlyze.com/api/v1

GET /api/v1 returns a machine-readable index of available resources and parameters. It also returns the current MCP endpoint path:

{
  "mcp_endpoint": "/api/mcp"
}

Authentication

Send an API key on every request:

Authorization: Bearer aeo_live_...

Formats

Every resource supports JSON by default:

GET /api/v1/prompts

Append format=csv for CSV:

GET /api/v1/prompts?format=csv

Read-only scope

The public API does not mutate workspace data. It does not expose billing, plan internals, quotas, or raw provider request/response payloads.