Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.
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
https://api.spreadjam.com/v1
Send your key as a bearer token on every request:
Authorization: Bearer sk_...
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
export JAM=https://api.spreadjam.com/v1auth=(-H "Authorization: Bearer $JAM_API_KEY")curl -sS "${auth[@]}" $JAM/me # which workspace this key is forcurl -sS "${auth[@]}" $JAM/analytics/overview # visibility, mentions, citationscurl -sS "${auth[@]}" "$JAM/prompts?limit=20" # what is tracked, one pagecurl -sS "${auth[@]}" $JAM/actions # the Plan: what to do nextcurl -sS "${auth[@]}" $JAM/credits # credits left and when they reset
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"}.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Jam","description":"Jam shows where AI assistants recommend you, works out what to change, and ships the work. Use it from the dashboard or from your own agent over MCP and the API.","colors":{"primary":"#fa114e","light":"#ff8391","dark":"#fa114e"},"logo":{"light":"https://mintcdn.com/jam-36116c1b/Q2bEwysERX7io6xB/logo/light.svg?fit=max\u0026auto=format\u0026n=Q2bEwysERX7io6xB\u0026q=85\u0026s=9fbd0712f07c22e5f1f12d15331b5cd5","dark":"https://mintcdn.com/jam-36116c1b/Q2bEwysERX7io6xB/logo/dark.svg?fit=max\u0026auto=format\u0026n=Q2bEwysERX7io6xB\u0026q=85\u0026s=3cd480957e2b172232e182772986c27b","href":"https://www.spreadjam.com"},"favicon":"https://mintcdn.com/jam-36116c1b/Q2bEwysERX7io6xB/favicon.svg?fit=max\u0026auto=format\u0026n=Q2bEwysERX7io6xB\u0026q=85\u0026s=f784ca54079838986dad2b7706511738","appearance":{"default":"system"},"background":{"color":{"light":"#f1f1f1","dark":"#1c1b24"}},"navbar":{"links":[{"href":"https://www.spreadjam.com/pricing","label":"Pricing"},{"href":"https://www.spreadjam.com/blogs","label":"Blog"},{"href":"https://www.spreadjam.com/changelog","label":"Changelog"},{"href":"https://www.spreadjam.com/start","label":"Log in"}],"primary":{"type":"button","label":"Start free","href":"https://www.spreadjam.com/start"}},"footer":{"socials":{"x":"https://x.com/wespreadjam","github":"https://github.com/wespreadjam","linkedin":"https://www.linkedin.com/company/108739060","discord":"https://dsc.gg/spreadjam"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://www.spreadjam.com/pricing"},{"label":"API playground","href":"https://www.spreadjam.com/api-playground"},{"label":"Changelog","href":"https://www.spreadjam.com/changelog"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://www.spreadjam.com/blogs"},{"label":"OpenAPI spec","href":"https://api.spreadjam.com/openapi.json"},{"label":"Book a call","href":"https://cal.com/jam-jam/aeo"}]}]},"fonts":{"family":"Geist"},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark-dimmed"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jam-36116c1b","hasAudioNarration":false,"actualSubdomain":"jam-36116c1b","customDomains":["docs.spreadjam.com"],"gitSource":{"type":"github","owner":"wespreadjam","repo":"jam-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af0db943114818fb90f8e07","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API and MCP reference","count":98},{"language":"default","tag":"Endpoints","count":94},{"language":"default","tag":"Prompts","count":13},{"language":"default","tag":"Actions","count":12},{"language":"default","tag":"Onboard with your agent","count":10},{"language":"default","tag":"Opportunities","count":9},{"language":"default","tag":"Brand","count":8},{"language":"default","tag":"Content","count":7},{"language":"default","tag":"Destinations","count":5},{"language":"default","tag":"Research","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--jam-brand: #fa114e;--jam-ink: #3d3b4f;--jam-paper: #f1f1f1;--jam-raised: #e9e9ea;--jam-line: rgba(85, 83, 104, 0.3);--jam-rule: rgba(85, 83, 104, 0.16);--jam-muted: rgba(61, 59, 79, 0.72);--jam-code-bg: #e8e8ea;--jam-mono: \"Geist Mono\", ui-monospace, Menlo, monospace}html.dark{--jam-ink: #ecebf2;--jam-paper: #1c1b24;--jam-raised: #24232e;--jam-line: rgba(236, 235, 242, 0.18);--jam-rule: rgba(236, 235, 242, 0.12);--jam-muted: rgba(236, 235, 242, 0.62);--jam-code-bg: #24232e}body,#content-area,#page-title,#content-area h1,#content-area h2,#content-area h3,#content-area h4{color:var(--jam-ink)}#content-area p,#content-area li,#content-area td{color:var(--jam-ink)}#page-title,#content-area h1,#content-area h2,#content-area h3{letter-spacing:-0.025em;font-weight:500}#page-title{letter-spacing:-0.035em}#navbar{background:var(--jam-paper);border-bottom:1px solid var(--jam-rule)}code,pre,kbd,pre code,[data-component-part=\"code-block-root\"]{font-family:var(--jam-mono)!important}#content-area :not(pre)>code{background:var(--jam-code-bg);color:var(--jam-ink);border:1px solid var(--jam-rule);border-radius:3px;padding:0.1em 0.35em;font-size:0.875em}#content-area pre,#content-area .code-block,#content-area [data-component-part=\"code-block-root\"],#content-area .code-group{border-radius:3px!important}html:not(.dark) #content-area pre,html:not(.dark) #content-area [data-component-part=\"code-block-root\"]{background:var(--jam-code-bg)!important}html.dark #content-area pre,html.dark #content-area [data-component-part=\"code-block-root\"],html.dark pre,html.dark code[class*=\"language-\"]{background:var(--jam-code-bg)!important}#content-area [data-callout]{border-radius:3px}#content-area a[data-component-part=\"card\"],#content-area .card{border-radius:3px;box-shadow:none;border-color:var(--jam-line)}#content-area a.card:hover,#content-area a[data-component-part=\"card\"]:hover{border-color:var(--jam-brand)}#content-area table th,#content-area table td{border-color:var(--jam-rule)}#content-area table th{font-weight:500}#content-area p a,#content-area li a,#content-area td a{color:var(--jam-ink);text-decoration:underline;text-decoration-color:var(--jam-brand);text-underline-offset:3px;border-bottom:none}#content-area p a:hover,#content-area li a:hover,#content-area td a:hover{color:var(--jam-brand)}#sidebar .sidebar-group-header,#sidebar [data-component-part=\"sidebar-group-title\"]{font-family:var(--jam-mono);font-weight:400;letter-spacing:0.08em;text-transform:uppercase;font-size:0.72rem;color:var(--jam-muted)}#navbar a[class*=\"rounded\"],#navbar button[class*=\"rounded\"]{border-radius:3px}"}]}
{"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API overview","description":"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.","href":"/api-reference/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`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 `,_jsx(_components.strong,{children:`Endpoints`}),` in this section, built from the live `,_jsx(_components.a,{href:`https://api.spreadjam.com/openapi.json`,children:`OpenAPI spec`}),`, so it matches what the API serves. Try requests in the browser in the `,_jsx(_components.a,{href:`https://www.spreadjam.com/api-playground`,children:`API playground`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url-and-auth`,children:`Base URL and auth`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark-dimmed`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#22272e`,color:`#24292e`,\"--shiki-dark\":`#adbac7`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`https://api.spreadjam.com/v1`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Send your key as a bearer token on every request:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark-dimmed`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#22272e`,color:`#24292e`,\"--shiki-dark\":`#adbac7`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#22863A`,\"--shiki-dark\":`#8DDB8C`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`:`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:` Bearer sk_...`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Create a key in `,_jsx(_components.strong,{children:`Settings`}),`, `,_jsx(_components.strong,{children:`Developer`}),`, `,_jsx(_components.strong,{children:`Create API key`}),`. It is shown once. Keys look like `,_jsx(_components.code,{children:`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 `,_jsx(_components.a,{href:`/onboard-with-your-agent/agent-connect`,children:`agent connect`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`A missing or invalid key returns `,_jsx(_components.code,{children:`401`}),`. Every error uses one body with a stable `,_jsx(_components.code,{children:`code`}),` and a `,_jsx(_components.code,{children:`requestId`}),`: see `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors and limits`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`try-it`,children:`Try it`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark-dimmed`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#22272e`,color:`#24292e`,\"--shiki-dark\":`#adbac7`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`export`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` JAM`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`https://api.spreadjam.com/v1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`(`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`-H`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`$JAM_API_KEY`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#F69D50`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:` -sS`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:' \"${'}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`[`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`@`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`]}\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` $JAM`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`/me`}),_jsx(_components.span,{style:{color:`#6A737D`,\"--shiki-dark\":`#768390`},children:` # which workspace this key is for`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#F69D50`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:` -sS`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:' \"${'}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`[`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`@`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`]}\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` $JAM`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`/analytics/overview`}),_jsx(_components.span,{style:{color:`#6A737D`,\"--shiki-dark\":`#768390`},children:` # visibility, mentions, citations`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#F69D50`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:` -sS`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:' \"${'}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`[`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`@`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`]}\"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:` \"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`$JAM`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`/prompts?limit=20\"`}),_jsx(_components.span,{style:{color:`#6A737D`,\"--shiki-dark\":`#768390`},children:` # what is tracked, one page`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#F69D50`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:` -sS`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:' \"${'}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`[`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`@`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`]}\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` $JAM`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`/actions`}),_jsx(_components.span,{style:{color:`#6A737D`,\"--shiki-dark\":`#768390`},children:` # the Plan: what to do next`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#F69D50`},children:`curl`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:` -sS`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:' \"${'}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`auth`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`[`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#F47067`},children:`@`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`]}\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` $JAM`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`/credits`}),_jsx(_components.span,{style:{color:`#6A737D`,\"--shiki-dark\":`#768390`},children:` # credits left and when they reset`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Always send `,_jsx(_components.code,{children:`limit`}),` to `,_jsx(_components.code,{children:`/v1/prompts`}),`: without it the response also carries the older `,_jsx(_components.code,{children:`tracked`}),` and `,_jsx(_components.code,{children:`archived`}),` lists next to the first page, which is a few hundred KB on a large project.`]}),`\n`,_jsx(Heading,{level:`2`,id:`projects`,children:`Projects`}),`\n`,_jsxs(_components.p,{children:[`A project is one website Jam tracks. Project routes act on the newest active project unless you send `,_jsx(_components.code,{children:`X-Jam-Project: \u003cprojectId>`}),` (ids from `,_jsx(_components.code,{children:`GET /v1/projects`}),`). Routes for one item by id (`,_jsx(_components.code,{children:`/v1/actions/{actionId}`}),`, `,_jsx(_components.code,{children:`/v1/content/{contentId}`}),`, …) act on that item wherever it lives in the workspace.`]}),`\n`,_jsx(Heading,{level:`2`,id:`lists-and-pages`,children:`Lists and pages`}),`\n`,_jsxs(_components.p,{children:[`Lists that can grow are paged the same way: `,_jsx(_components.code,{children:`limit`}),` (1 to 100) and `,_jsx(_components.code,{children:`cursor`}),` in, `,_jsx(_components.code,{children:`pageInfo`}),` out.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light github-dark-dimmed`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#22272e`,color:`#24292e`,\"--shiki-dark\":`#adbac7`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`\"pageInfo\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`: { `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#8DDB8C`},children:`\"limit\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:`100`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`, `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#8DDB8C`},children:`\"hasNextPage\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:`true`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`, `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#8DDB8C`},children:`\"nextCursor\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`: `}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#96D0FF`},children:`\"eyJhIjo...\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`, `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#8DDB8C`},children:`\"totalCount\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#6CB6FF`},children:`326`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#ADBAC7`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`hasNextPage`}),` is true, send `,_jsx(_components.code,{children:`nextCursor`}),` back as `,_jsx(_components.code,{children:`cursor`}),` with the same filters. `,_jsx(_components.code,{children:`totalCount`}),` counts every match across all pages.`]}),`\n`,_jsx(Heading,{level:`2`,id:`writes`,children:`Writes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Send `,_jsx(_components.code,{children:`Idempotency-Key`}),` on writes you might retry.`]}),`\n`,_jsxs(_components.li,{children:[`Work that hands off to Jam answers `,_jsx(_components.code,{children:`202`}),`; read the result back from the resource it names.`]}),`\n`,_jsxs(_components.li,{children:[`Writes need an active plan. When a plan ends, writes answer `,_jsx(_components.code,{children:`402 plan_inactive`}),`; see `,_jsx(_components.a,{href:`/billing/plans-and-credits`,children:`Plans and credits`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`use-it-from-an-agent`,children:`Use it from an agent`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`/api-reference/mcp`,children:`MCP server`}),` at `,_jsx(_components.code,{children:`https://api.spreadjam.com/mcp`}),` turns every endpoint into a tool, with the same auth, limits and errors. See `,_jsx(_components.a,{href:`/onboard-with-your-agent`,children:`Onboard with your agent`}),`.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`Python: set a `,_jsx(_components.code,{children:`User-Agent`}),` header.`]}),` The API sits behind Cloudflare, which blocks the default `,_jsx(_components.code,{children:`Python-urllib/3.x`}),` user agent with `,_jsx(_components.code,{children:`403`}),` (“error code: 1010”). Send your own, for example `,_jsx(_components.code,{children:`{\"User-Agent\": \"my-agent/1.0\"}`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark-dimmed"}},"config":{},"pageMetadata":{"title":"API overview","description":"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL and auth","slug":"base-url-and-auth","depth":2,"children":[]},{"title":"Try it","slug":"try-it","depth":2,"children":[]},{"title":"Projects","slug":"projects","depth":2,"children":[]},{"title":"Lists and pages","slug":"lists-and-pages","depth":2,"children":[]},{"title":"Writes","slug":"writes","depth":2,"children":[]},{"title":"Use it from an agent","slug":"use-it-from-an-agent","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"jam-36116c1b","siteName":"Jam","title":"API overview - Jam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T21:41:09.109Z","originalFileLocation":"api-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Jam\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API overview - Jam\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Jam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spreadjam.com/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jam-36116c1b.mintlify.site/_mintlify/api/og/v2?division=API+and+MCP+reference\u0026amp;title=API+overview\u0026amp;description=Authenticate+with+a+workspace+API+key+and+call+the+Jam+REST+API+over+HTTPS.+Every+endpoint+is+also+an+MCP+tool.\u0026amp;theme=9acacffd897656ae8c357786\u0026amp;signature=53cbf21f83010dc2c07b13bbe49779fef11843b7814e3030b6368dbb6a11d825\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API overview - Jam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jam-36116c1b.mintlify.site/_mintlify/api/og/v2?division=API+and+MCP+reference\u0026amp;title=API+overview\u0026amp;description=Authenticate+with+a+workspace+API+key+and+call+the+Jam+REST+API+over+HTTPS.+Every+endpoint+is+also+an+MCP+tool.\u0026amp;theme=9acacffd897656ae8c357786\u0026amp;signature=53cbf21f83010dc2c07b13bbe49779fef11843b7814e3030b6368dbb6a11d825\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/ZceF-YL_afGaQ5w1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Jam\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#fa114e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spreadjam.com/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spreadjam.com/#organization\",\"name\":\"Jam\",\"url\":\"https://docs.spreadjam.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jam-36116c1b/Q2bEwysERX7io6xB/logo/light.svg?fit=max\u0026auto=format\u0026n=Q2bEwysERX7io6xB\u0026q=85\u0026s=9fbd0712f07c22e5f1f12d15331b5cd5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spreadjam.com#website\",\"name\":\"Jam\",\"url\":\"https://docs.spreadjam.com\",\"publisher\":{\"@id\":\"https://docs.spreadjam.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spreadjam.com/api-reference/overview#webpage\",\"url\":\"https://docs.spreadjam.com/api-reference/overview\",\"name\":\"API overview\",\"description\":\"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\",\"dateModified\":\"2026-11-07T21:41:09.109Z\",\"isPartOf\":{\"@id\":\"https://docs.spreadjam.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spreadjam.com/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spreadjam.com/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Jam\",\"item\":\"https://docs.spreadjam.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API overview\",\"item\":\"https://docs.spreadjam.com/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.spreadjam.com/api-reference/overview#article\",\"headline\":\"API overview\",\"name\":\"API overview\",\"description\":\"Authenticate with a workspace API key and call the Jam REST API over HTTPS. Every endpoint is also an MCP tool.\",\"url\":\"https://docs.spreadjam.com/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spreadjam.com/api-reference/overview#webpage\"},\"dateModified\":\"2026-11-07T21:41:09.109Z\",\"publisher\":{\"@id\":\"https://docs.spreadjam.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spreadjam.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Jam\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Jam\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/overview.md","siteName":"Jam","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Jam docs","sidebarTitle":"Introduction","href":"/index"},{"title":"Quickstart","href":"/get-started/quickstart"},{"title":"Concepts","href":"/get-started/concepts"}]},{"group":"Onboard with your agent","pages":[{"title":"Onboard with your agent","sidebarTitle":"Overview","href":"/onboard-with-your-agent"},{"title":"Claude","href":"/onboard-with-your-agent/claude"},{"title":"Claude Code","href":"/onboard-with-your-agent/claude-code"},{"title":"ChatGPT","href":"/onboard-with-your-agent/chatgpt"},{"title":"Cursor","href":"/onboard-with-your-agent/cursor"},{"title":"Other MCP clients","href":"/onboard-with-your-agent/other-clients"},{"title":"Agent connect","href":"/onboard-with-your-agent/agent-connect"},{"title":"What your agent can do","href":"/onboard-with-your-agent/what-your-agent-can-do"},{"title":"Copy prompt","href":"/onboard-with-your-agent/copy-prompt"},{"title":"How to operate Jam","href":"/onboard-with-your-agent/operating-guide"}]},{"group":"Tracking","pages":[{"title":"Tracking","sidebarTitle":"Overview","href":"/tracking/overview"},{"title":"Prompts","href":"/tracking/prompts"},{"title":"Scans and answers","href":"/tracking/scans-and-answers"}]},{"group":"Research","pages":[{"title":"Research","sidebarTitle":"Overview","href":"/research/overview"}]},{"group":"Actions","pages":[{"title":"The Plan","href":"/actions/the-plan"},{"title":"Doing the work","href":"/actions/doing-the-work"}]},{"group":"Delivery","pages":[{"title":"Delivery","sidebarTitle":"Overview","href":"/delivery/overview"},{"title":"GitHub","href":"/delivery/github"},{"title":"Markdown","description":"Get each article as Markdown to publish yourself, or hand it to your coding agent to add to your site.","href":"/delivery/markdown"}]},{"group":"API and MCP reference","pages":[{"title":"API overview","href":"/api-reference/overview"},{"title":"MCP server","description":"The Jam MCP server at https://api.spreadjam.com/mcp: one tool per API route, OAuth or key auth, tool annotations and project selection.","href":"/api-reference/mcp"},{"title":"Errors and limits","href":"/api-reference/errors"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"group":"Endpoints","expanded":false,"pages":[{"group":"Meta","pages":[{"title":"The authenticated key's workspace","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/me","href":"/api-reference/meta/the-authenticated-keys-workspace"}]},{"group":"Analytics","pages":[{"title":"AI-visibility overview","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/analytics/overview","href":"/api-reference/analytics/ai-visibility-overview"},{"title":"Per-prompt analytics","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/analytics/prompts","href":"/api-reference/analytics/per-prompt-analytics"},{"title":"Flattened metric rows","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/analytics/metrics","href":"/api-reference/analytics/flattened-metric-rows"}]},{"group":"Keywords","pages":[{"title":"Keyword and topic visibility","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/keywords","href":"/api-reference/keywords/keyword-and-topic-visibility"}]},{"group":"Brand","pages":[{"title":"The active brand profile","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/brand","href":"/api-reference/brand/the-active-brand-profile"},{"title":"Save brand positioning","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/brand","href":"/api-reference/brand/save-brand-positioning"},{"title":"Pin the competitor list","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json put /v1/brand/competitors","href":"/api-reference/brand/pin-the-competitor-list"},{"title":"Add competitors","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/brand/competitors","href":"/api-reference/brand/add-competitors"},{"title":"Clear the competitor pin","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/brand/competitors","href":"/api-reference/brand/clear-the-competitor-pin"},{"title":"Start a recalibration","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/brand/recalibrations","href":"/api-reference/brand/start-a-recalibration"},{"title":"Remove a competitor","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/brand/competitors/{name}","href":"/api-reference/brand/remove-a-competitor"},{"title":"Set a competitor's domain or other names","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/brand/competitors/{name}","href":"/api-reference/brand/set-a-competitors-domain-or-other-names"}]},{"group":"Prompts","pages":[{"title":"Tracked and archived prompts","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/prompts","href":"/api-reference/prompts/tracked-and-archived-prompts"},{"title":"Reword many prompts at once","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json put /v1/prompts","href":"/api-reference/prompts/reword-many-prompts-at-once"},{"title":"Track a new prompt","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/prompts","href":"/api-reference/prompts/track-a-new-prompt"},{"title":"Prompt cap state","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/prompts/cap","href":"/api-reference/prompts/prompt-cap-state"},{"title":"Live prompts by topic","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/prompts/topics","href":"/api-reference/prompts/live-prompts-by-topic"},{"title":"Stop tracking a whole topic","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/prompts/topics/{topic}","href":"/api-reference/prompts/stop-tracking-a-whole-topic"},{"title":"Progress of the latest suggestion fill","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/prompts/suggestions","href":"/api-reference/prompts/progress-of-the-latest-suggestion-fill"},{"title":"Suggest more prompts","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/prompts/suggestions","href":"/api-reference/prompts/suggest-more-prompts"},{"title":"Stop tracking a prompt","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/prompts/{promptId}","href":"/api-reference/prompts/stop-tracking-a-prompt"},{"title":"Reword a prompt in place","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/prompts/{promptId}","href":"/api-reference/prompts/reword-a-prompt-in-place"},{"title":"Track many prompts at once","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/prompts/bulk","href":"/api-reference/prompts/track-many-prompts-at-once"},{"title":"Pause or resume a prompt","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/prompts/{promptId}/pause","href":"/api-reference/prompts/pause-or-resume-a-prompt"},{"title":"Replace a prompt, resetting history","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/prompts/{promptId}/replacements","href":"/api-reference/prompts/replace-a-prompt-resetting-history"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/api-keys/{keyId}","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Opportunities","pages":[{"title":"List opportunities","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/opportunities","href":"/api-reference/opportunities/list-opportunities"},{"title":"Get an opportunity","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/opportunities/{opportunityId}","href":"/api-reference/opportunities/get-an-opportunity"},{"title":"Dismiss an opportunity","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/opportunities/{opportunityId}/dismissal","href":"/api-reference/opportunities/dismiss-an-opportunity"},{"title":"Restore a dismissed opportunity","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/opportunities/{opportunityId}/dismissal","href":"/api-reference/opportunities/restore-a-dismissed-opportunity"},{"title":"Create content from an opportunity","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/opportunities/{opportunityId}/plan-requests","href":"/api-reference/opportunities/create-content-from-an-opportunity"},{"title":"The brief to write an article from","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/opportunities/{opportunityId}/brief","href":"/api-reference/opportunities/the-brief-to-write-an-article-from"},{"title":"Claim an opportunity for an agent","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/opportunities/{opportunityId}/claims","href":"/api-reference/opportunities/claim-an-opportunity-for-an-agent"},{"title":"Release an agent claim","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/opportunities/{opportunityId}/claims/current","href":"/api-reference/opportunities/release-an-agent-claim"},{"title":"Report that the agent could not write it","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/opportunities/{opportunityId}/agent-failures","href":"/api-reference/opportunities/report-that-the-agent-could-not-write-it"}]},{"group":"Planning","pages":[{"title":"Plan now","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/plan-batches","href":"/api-reference/planning/plan-now"}]},{"group":"Content","pages":[{"title":"List content","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content","href":"/api-reference/content/list-content"},{"title":"Store a draft","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content","href":"/api-reference/content/store-a-draft"},{"title":"Get content","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}","href":"/api-reference/content/get-content"},{"title":"Discard content","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/content/{contentId}","href":"/api-reference/content/discard-content"},{"title":"Restore discarded content","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content/{contentId}/restorations","href":"/api-reference/content/restore-discarded-content"},{"title":"Write the content again","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content/{contentId}/regenerations","href":"/api-reference/content/write-the-content-again"},{"title":"Request an edit","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content/{contentId}/edit-requests","href":"/api-reference/content/request-an-edit"}]},{"group":"Revisions","pages":[{"title":"List revisions","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}/revisions","href":"/api-reference/revisions/list-revisions"},{"title":"Store a revision","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content/{contentId}/revisions","href":"/api-reference/revisions/store-a-revision"},{"title":"Get a revision","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}/revisions/{revisionId}","href":"/api-reference/revisions/get-a-revision"}]},{"group":"Publishing","pages":[{"title":"Content's destinations","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}/destinations","href":"/api-reference/publishing/contents-destinations"},{"title":"Publish content to a destination","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json put /v1/content/{contentId}/destinations/{destinationId}","href":"/api-reference/publishing/publish-content-to-a-destination"},{"title":"Cancel publishing to a destination","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/content/{contentId}/destinations/{destinationId}","href":"/api-reference/publishing/cancel-publishing-to-a-destination"}]},{"group":"Deliveries","pages":[{"title":"Content's deliveries","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}/deliveries","href":"/api-reference/deliveries/contents-deliveries"}]},{"group":"Publications","pages":[{"title":"Content's publications","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/content/{contentId}/publications","href":"/api-reference/publications/contents-publications"},{"title":"Mark as published","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/content/{contentId}/publications","href":"/api-reference/publications/mark-as-published"}]},{"group":"Destinations","pages":[{"title":"List destinations","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/destinations","href":"/api-reference/destinations/list-destinations"},{"title":"Add a destination","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/destinations","href":"/api-reference/destinations/add-a-destination"},{"title":"Remove a destination","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/destinations/{destinationId}","href":"/api-reference/destinations/remove-a-destination"},{"title":"Change publishing policy","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/destinations/{destinationId}","href":"/api-reference/destinations/change-publishing-policy"},{"title":"Connect a GitHub repository","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json put /v1/destinations/{destinationId}/github","href":"/api-reference/destinations/connect-a-github-repository"}]},{"group":"Visibility runs","pages":[{"title":"List visibility runs","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/visibility-runs","href":"/api-reference/visibility-runs/list-visibility-runs"},{"title":"Run the visibility scan now","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/visibility-runs","href":"/api-reference/visibility-runs/run-the-visibility-scan-now"},{"title":"Get a visibility run","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/visibility-runs/{runId}","href":"/api-reference/visibility-runs/get-a-visibility-run"}]},{"group":"Credits","pages":[{"title":"The credit balance","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/credits","href":"/api-reference/credits/the-credit-balance"}]},{"group":"Actions","pages":[{"title":"List actions","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/actions","href":"/api-reference/actions/list-actions"},{"title":"Read an action","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/actions/{actionId}","href":"/api-reference/actions/read-an-action"},{"title":"Mark an action done","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/completion","href":"/api-reference/actions/mark-an-action-done"},{"title":"Mark an action started","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/start","href":"/api-reference/actions/mark-an-action-started"},{"title":"Report an outreach pitch sent","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/sent","href":"/api-reference/actions/report-an-outreach-pitch-sent"},{"title":"Dismiss an action","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/dismissal","href":"/api-reference/actions/dismiss-an-action"},{"title":"Restore a dismissed action","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/actions/{actionId}/dismissal","href":"/api-reference/actions/restore-a-dismissed-action"},{"title":"Check a done action again","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/checks","href":"/api-reference/actions/check-a-done-action-again"},{"title":"Have Jam do an action","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/actions/{actionId}/executions","href":"/api-reference/actions/have-jam-do-an-action"},{"title":"Report an action done with its completion token","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/action-completions/{token}","href":"/api-reference/actions/report-an-action-done-with-its-completion-token"}]},{"group":"Agent connect","pages":[{"title":"Start an agent connect session","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/agent-connect","href":"/api-reference/agent-connect/start-an-agent-connect-session"},{"title":"Poll an agent connect session","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/agent-connect/{pollToken}","href":"/api-reference/agent-connect/poll-an-agent-connect-session"}]},{"group":"Pricing","pages":[{"title":"Plans and prices","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/pricing","href":"/api-reference/pricing/plans-and-prices"}]},{"group":"Site changes","pages":[{"title":"Read a site change","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/site-changes/{changeId}","href":"/api-reference/site-changes/read-a-site-change"},{"title":"Discard a site change","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/site-changes/{changeId}","href":"/api-reference/site-changes/discard-a-site-change"},{"title":"Open the pull request for a site change","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/site-changes/{changeId}/pull-requests","href":"/api-reference/site-changes/open-the-pull-request-for-a-site-change"}]},{"group":"Research","pages":[{"title":"Read the research state","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/research","href":"/api-reference/research/read-the-research-state"},{"title":"Read the latest research report","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/research/report","href":"/api-reference/research/read-the-latest-research-report"},{"title":"Research again","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/research-requests","href":"/api-reference/research/research-again"}]},{"group":"Answers","pages":[{"title":"List AI answers","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/answers","href":"/api-reference/answers/list-ai-answers"},{"title":"List one prompt's answers","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/prompts/{promptId}/answers","href":"/api-reference/answers/list-one-prompts-answers"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-a-project"}]},{"group":"Billing","pages":[{"title":"Plan state and billing links","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/billing","href":"/api-reference/billing/plan-state-and-billing-links"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Add a webhook","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/add-a-webhook"},{"title":"Remove a webhook","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json delete /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/remove-a-webhook"},{"title":"Rename, enable or disable a webhook","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/rename-enable-or-disable-a-webhook"}]},{"group":"Notifications","pages":[{"title":"Notification rules","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/notification-rules","href":"/api-reference/notifications/notification-rules"},{"title":"Change a notification rule","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json patch /v1/notification-rules/{category}","href":"/api-reference/notifications/change-a-notification-rule"}]}]}]},{"group":"Billing","pages":[{"title":"Plans and credits","href":"/billing/plans-and-credits"}]}]},"basePath":"","title":"API overview - Jam","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}