Skip to main content
The Jam Platform API lets you read your AI-visibility data and manage your tracked prompts and brand profile from your own scripts, dashboards, and agents. Every endpoint is documented in the API Reference tab, created directly from the live OpenAPI spec so it never drifts from what the API serves.

​
Get an API key

  1. Open your Jam workspace and go to Settings, then Developer.
  2. Click Create API key and give it a name.
  3. Copy the key. It is shown once. Test keys begin with sk_test_ and are available on every plan. Live keys require a paid plan.
Keys are scoped to the workspace that created them. Revoking a key takes effect immediately.

​
Base URL and auth

Send your key as a bearer token on every request:
A missing or invalid key returns 401. Every error uses the same shape, { "error": string }, with the status carrying the meaning.

​
Try it

​
Explore the endpoints

Browse the full, always-current reference in the API Reference tab. It covers your identity (/v1/me), AI-visibility analytics, keyword and topic rankings, your brand profile and competitors, and tracked prompts, each with parameters, response schemas, and a request builder. The machine-readable spec is served at https://api.spreadjam.com/openapi.json.

​
Use with Claude

The responses are structured so an agent can act on them directly. Run claude in a shell that already has JAM_API_KEY exported, then ask it to call an endpoint:
For Claude Desktop, the same prompt works with a shell MCP server enabled. Otherwise paste the response into a conversation and ask for the summary you want.