Skip to main content
The Jam REST API exposes everything the dashboard does: visibility, answers, prompts, brand, research, the Plan, content, delivery, credits, billing and webhooks. Every endpoint is listed under Endpoints in this section, built from the live OpenAPI spec, so it matches what the API serves. Try requests in the browser in the API playground.

Base URL and auth

Send your key as a bearer token on every request:
Create a key in Settings, Developer, Create API key. It is shown once. Keys look like sk_ followed by 64 hex characters and reach the workspace’s real data; there are no test keys. A key acts with its creator’s role, and revoking it takes effect immediately. An agent can also get a key for its human with agent connect. A missing or invalid key returns 401. Every error uses one body with a stable code and a requestId: see Errors and limits.

Try it

Always send limit to /v1/prompts: without it the response also carries the older tracked and archived lists next to the first page, which is a few hundred KB on a large project.

Projects

A project is one website Jam tracks. Project routes act on the newest active project unless you send X-Jam-Project: <projectId> (ids from GET /v1/projects). Routes for one item by id (/v1/actions/{actionId}, /v1/content/{contentId}, …) act on that item wherever it lives in the workspace.

Lists and pages

Lists that can grow are paged the same way: limit (1 to 100) and cursor in, pageInfo out.
When hasNextPage is true, send nextCursor back as cursor with the same filters. totalCount counts every match across all pages.

Writes

  • Send Idempotency-Key on writes you might retry.
  • Work that hands off to Jam answers 202; read the result back from the resource it names.
  • Writes need an active plan. When a plan ends, writes answer 402 plan_inactive; see Plans and credits.

Use it from an agent

The MCP server at https://api.spreadjam.com/mcp turns every endpoint into a tool, with the same auth, limits and errors. See Onboard with your agent.
Python: set a User-Agent header. The API sits behind Cloudflare, which blocks the default Python-urllib/3.x user agent with 403 (“error code: 1010”). Send your own, for example {"User-Agent": "my-agent/1.0"}.