{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Jam","colors":{"primary":"#171717","light":"#fafafa","dark":"#171717"},"logo":{"light":"https://mintcdn.com/jam-36116c1b/Z4UCRdbMnRXP3N41/logo/light.svg?fit=max\u0026auto=format\u0026n=Z4UCRdbMnRXP3N41\u0026q=85\u0026s=5df61071003be58ac103098e3b07a9aa","dark":"https://mintcdn.com/jam-36116c1b/Z4UCRdbMnRXP3N41/logo/dark.svg?fit=max\u0026auto=format\u0026n=Z4UCRdbMnRXP3N41\u0026q=85\u0026s=784f3fe38366b7397234a6eb36c13a01"},"favicon":"https://mintcdn.com/jam-36116c1b/Z4UCRdbMnRXP3N41/favicon.svg?fit=max\u0026auto=format\u0026n=Z4UCRdbMnRXP3N41\u0026q=85\u0026s=a7e8c7a200bb2f9ef3f00d746b1eebea","appearance":{"default":"light"},"background":{"color":{"light":"#FAF9F5","dark":"#1c1c1c"}},"navbar":{"links":[{"href":"https://www.spreadjam.com/blogs","label":"Blog"},{"href":"https://www.spreadjam.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Get started","href":"https://www.spreadjam.com"}},"footer":{"socials":{"x":"https://x.com/wespreadjam","github":"https://github.com/wespreadjam","linkedin":"https://www.linkedin.com/company/108739060","discord":"https://dsc.gg/spreadjam"}},"fonts":{"family":"Inter"},"styling":{"codeblocks":{},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"metadata":{"timestamp":false},"navigation":{"global":{"anchors":[{"anchor":"Website","href":"https://www.spreadjam.com"},{"anchor":"Blog","href":"https://www.spreadjam.com/blogs"},{"anchor":"Open Source","href":"https://github.com/wespreadjam/jam-nodes"},{"anchor":"Discord","href":"https://dsc.gg/spreadjam"},{"anchor":"npm","href":"https://www.npmjs.com/org/jam-nodes"}]},"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":""},"chroma":{"liveDeploymentHistoryId":"6aec9ae83744ce14d084a355","collectionId":"56490d04-0393-4d18-ab6b-454bfd1eab38","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec9ae83744ce14d084a355"},"entitlements":{},"buildId":"6aece1d6e8f4a44bf4151964","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":94},{"language":"default","tag":"jam-nodes (workflow library)","count":16},{"language":"default","tag":"Prompts","count":13},{"language":"default","tag":"GEO for agents","count":12},{"language":"default","tag":"Actions","count":10},{"language":"default","tag":"Opportunities","count":9},{"language":"default","tag":"Brand","count":8},{"language":"default","tag":"Content","count":7},{"language":"default","tag":"Built-in Nodes","count":5},{"language":"default","tag":"Destinations","count":5}]},"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":"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":"llms-txt-v2","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":"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":"vite-origin","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"html.dark pre,html.dark .codeblock-dark pre{background:#2a2a2a!important}html.dark code[class*=\"language-\"]{background:#2a2a2a!important}"}],"page":{"pagePath":"api-reference/credits/the-credit-balance","slug":"/api-reference/credits/the-credit-balance","pageMetadata":{"title":"The credit balance","description":"The key's workspace credit balance, plan allowance, refill time and recent charges.","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/credits","href":"/api-reference/credits/the-credit-balance","autogeneratedByOpenApi":true},"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: \"The key’s workspace credit balance, plan allowance, refill time and recent charges.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{},"config":{},"pageMetadata":{"title":"The credit balance","description":"The key's workspace credit balance, plan allowance, refill time and recent charges.","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/credits","href":"/api-reference/credits/the-credit-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_credits","tags":["Credits"],"summary":"The credit balance","description":"The key's workspace credit balance, plan allowance, refill time and recent charges.","security":["d813075d-93f7-4590-9ab2-9b971fe6fea0"],"parameters":["bdc88b54-533f-43bc-935f-7a07ec86a7f2"],"responses":{"200":"aa2eca52-ee25-4d06-9edf-dda61c6708de","400":"44adc5b6-2331-454d-b67e-aacb26ad2cc6","401":"616f881d-eccb-450c-a5a2-46329e41e68b","404":"c2e9fdb9-a75c-44d5-a3b7-045fa6767532","429":"79f404e6-b936-426f-a5c7-54a9be0b12ae"},"method":"get","type":"path","servers":["40f652f2-7ec4-407b-8088-5928afe7d79b"],"path":"/v1/credits","baseUrlOptions":["https://api.spreadjam.com"],"title":"The credit balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bdc88b54-533f-43bc-935f-7a07ec86a7f2":{"schema":{"oneOf":[{"type":"integer","minimum":0,"maximum":50,"default":10,"description":"How many recent charges to include (default 10).","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":50,"default":10,"description":"How many recent charges to include (default 10).","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"required":false,"description":"How many recent charges to include (default 10).","name":"recent","in":"query"}},"responses":{"aa2eca52-ee25-4d06-9edf-dda61c6708de":{"description":"The credit balance.","content":{"application/json":{"schema":{"type":"object","properties":{"spendable":{"type":"integer","description":"Credits available now: allowance plus purchased.","isRequired":true,"uniqueKey":"spendable","typeLabel":"integer"},"allowanceBalance":{"type":"integer","description":"Credits left from the monthly allowance.","isRequired":true,"uniqueKey":"allowanceBalance","typeLabel":"integer"},"purchasedBalance":{"type":"integer","description":"Credits the workspace owner bought; spent after the allowance.","isRequired":true,"uniqueKey":"purchasedBalance","typeLabel":"integer"},"lifetimeUsed":{"type":"integer","isRequired":true,"uniqueKey":"lifetimeUsed","typeLabel":"integer"},"monthlyAllowance":{"oneOf":[{"type":"integer","description":"The monthly allowance the plan grants; null when the plan does not state one.","isRequired":true,"uniqueKey":"monthlyAllowance.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The monthly allowance the plan grants; null when the plan does not state one.","isRequired":true,"uniqueKey":"monthlyAllowance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monthlyAllowance","typeLabel":"integer | null"},"resetsAt":{"oneOf":[{"type":"string","description":"ISO-8601 UTC time the allowance next refills, when known.","isRequired":true,"uniqueKey":"resetsAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO-8601 UTC time the allowance next refills, when known.","isRequired":true,"uniqueKey":"resetsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resetsAt","typeLabel":"string | null"},"offer":{"type":"string","enum":["active","inactive","legacy"],"isRequired":true,"uniqueKey":"offer","typeLabel":"enum\u003cstring>"},"recentCharges":{"type":"array","items":{"type":"object","properties":{"operation":{"type":"string","description":"The ledger operation, e.g. `llm_query` or `geo_allowance_expiry`.","isRequired":true,"uniqueKey":"recentCharges.items.[INDEX].operation","typeLabel":"string"},"description":{"type":"string","description":"What the movement was, in plain words. A `geo_allowance_expiry` at signup is not a spend: the free allowance was replaced by the plan's credits.","isRequired":true,"uniqueKey":"recentCharges.items.[INDEX].description","typeLabel":"string"},"spend":{"type":"boolean","description":"False for plan bookkeeping (an expired allowance, a reversal), true for credits spent on work.","isRequired":true,"uniqueKey":"recentCharges.items.[INDEX].spend","typeLabel":"boolean"},"credits":{"type":"integer","description":"Credits moved out of the balance.","isRequired":true,"uniqueKey":"recentCharges.items.[INDEX].credits","typeLabel":"integer"},"at":{"type":"string","description":"ISO-8601 UTC timestamp.","isRequired":true,"uniqueKey":"recentCharges.items.[INDEX].at","typeLabel":"string"}},"required":["operation","description","spend","credits","at"],"uniqueKey":"recentCharges.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"recentCharges","typeLabel":"object[]"}},"required":["spendable","allowanceBalance","purchasedBalance","lifetimeUsed","monthlyAllowance","resetsAt","offer","recentCharges"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"spendable":123,"allowanceBalance":123,"purchasedBalance":123,"lifetimeUsed":123,"monthlyAllowance":123,"resetsAt":"\u003cstring>","offer":"active","recentCharges":[{"operation":"\u003cstring>","description":"\u003cstring>","spend":true,"credits":123,"at":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"44adc5b6-2331-454d-b67e-aacb26ad2cc6":{"description":"Invalid request: a parameter or body field is wrong. `details` lists each problem with what is allowed.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong and how to fix the request.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable code, e.g. invalid_request, unauthorized, rate_limited.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","description":"Echoes the X-Request-Id header; quote it to support.","uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"Where the error is explained.","uniqueKey":"docs","typeLabel":"string"},"resolveUrl":{"type":"string","description":"402/403 plan errors: the dashboard page that resolves it.","uniqueKey":"resolveUrl","typeLabel":"string"},"details":{"type":"array","description":"One entry per problem: path, message, and when known allowed, minimum, maximum, expected, received.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","requestId":"\u003cstring>","docs":"\u003cstring>","resolveUrl":"\u003cstring>","details":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"616f881d-eccb-450c-a5a2-46329e41e68b":{"description":"Missing, malformed or revoked API key (`Authorization: Bearer sk_…`).","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong and how to fix the request.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable code, e.g. invalid_request, unauthorized, rate_limited.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","description":"Echoes the X-Request-Id header; quote it to support.","uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"Where the error is explained.","uniqueKey":"docs","typeLabel":"string"},"resolveUrl":{"type":"string","description":"402/403 plan errors: the dashboard page that resolves it.","uniqueKey":"resolveUrl","typeLabel":"string"},"details":{"type":"array","description":"One entry per problem: path, message, and when known allowed, minimum, maximum, expected, received.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","requestId":"\u003cstring>","docs":"\u003cstring>","resolveUrl":"\u003cstring>","details":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c2e9fdb9-a75c-44d5-a3b7-045fa6767532":{"description":"The resource, or the project the key or `X-Jam-Project` selects, does not exist in this workspace.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong and how to fix the request.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable code, e.g. invalid_request, unauthorized, rate_limited.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","description":"Echoes the X-Request-Id header; quote it to support.","uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"Where the error is explained.","uniqueKey":"docs","typeLabel":"string"},"resolveUrl":{"type":"string","description":"402/403 plan errors: the dashboard page that resolves it.","uniqueKey":"resolveUrl","typeLabel":"string"},"details":{"type":"array","description":"One entry per problem: path, message, and when known allowed, minimum, maximum, expected, received.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","requestId":"\u003cstring>","docs":"\u003cstring>","resolveUrl":"\u003cstring>","details":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"79f404e6-b936-426f-a5c7-54a9be0b12ae":{"description":"`rate_limited` (per-key rate) or `too_many_concurrent` (expensive reads in flight); retry after `Retry-After` seconds.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong and how to fix the request.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable code, e.g. invalid_request, unauthorized, rate_limited.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","description":"Echoes the X-Request-Id header; quote it to support.","uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"Where the error is explained.","uniqueKey":"docs","typeLabel":"string"},"resolveUrl":{"type":"string","description":"402/403 plan errors: the dashboard page that resolves it.","uniqueKey":"resolveUrl","typeLabel":"string"},"details":{"type":"array","description":"One entry per problem: path, message, and when known allowed, minimum, maximum, expected, received.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","requestId":"\u003cstring>","docs":"\u003cstring>","resolveUrl":"\u003cstring>","details":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d813075d-93f7-4590-9ab2-9b971fe6fea0":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A workspace API key issued in Settings → Developer, sent as `Bearer sk_…`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"40f652f2-7ec4-407b-8088-5928afe7d79b":{"url":"https://api.spreadjam.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A workspace API key issued in Settings → Developer, sent as `Bearer sk_…`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key issued in Settings → Developer, sent as `Bearer sk_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.spreadjam.com/openapi.json"},"subdomain":"jam-36116c1b","siteName":"Jam","title":"The credit balance - Jam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T20:06:51.306Z","originalFileLocation":"api-reference/credits/the-credit-balance.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=\"light\"}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=\"The key\u0026#x27;s workspace credit balance, plan allowance, refill time and recent charges.\">\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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jam-36116c1b/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_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/s-db-a-nmBsVWeXu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The credit balance - Jam\">\u003cmeta data-mint-head property=\"og:description\" content=\"The key\u0026#x27;s workspace credit balance, plan allowance, refill time and recent charges.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Jam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance\">\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=Credits\u0026amp;title=The+credit+balance\u0026amp;description=The+key%27s+workspace+credit+balance%2C+plan+allowance%2C+refill+time+and+recent+charges.\u0026amp;theme=d8a8b5752475f2e19d0ccf23\u0026amp;signature=981d477171da1b0f92522d240d5c15573344bbceb7f3f812206e9540d0936a88\">\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=\"The credit balance - Jam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The key\u0026#x27;s workspace credit balance, plan allowance, refill time and recent charges.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jam-36116c1b.mintlify.site/_mintlify/api/og/v2?division=Credits\u0026amp;title=The+credit+balance\u0026amp;description=The+key%27s+workspace+credit+balance%2C+plan+allowance%2C+refill+time+and+recent+charges.\u0026amp;theme=d8a8b5752475f2e19d0ccf23\u0026amp;signature=981d477171da1b0f92522d240d5c15573344bbceb7f3f812206e9540d0936a88\">\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/s-db-a-nmBsVWeXu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Jam\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/credits/the-credit-balance.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/Z4UCRdbMnRXP3N41/logo/light.svg?fit=max\u0026auto=format\u0026n=Z4UCRdbMnRXP3N41\u0026q=85\u0026s=5df61071003be58ac103098e3b07a9aa\"}},{\"@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/credits/the-credit-balance#webpage\",\"url\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance\",\"name\":\"The credit balance\",\"description\":\"The key's workspace credit balance, plan allowance, refill time and recent charges.\",\"dateModified\":\"2026-11-05T20:06:51.306Z\",\"isPartOf\":{\"@id\":\"https://docs.spreadjam.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Jam\",\"item\":\"https://docs.spreadjam.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The credit balance\",\"item\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance#apireference\",\"headline\":\"The credit balance\",\"name\":\"The credit balance\",\"description\":\"The key's workspace credit balance, plan allowance, refill time and recent charges.\",\"url\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spreadjam.com/api-reference/credits/the-credit-balance#webpage\"},\"dateModified\":\"2026-11-05T20:06:51.306Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Jam","nav":{"global":{"anchors":[{"anchor":"Website","href":"https://www.spreadjam.com"},{"anchor":"Blog","href":"https://www.spreadjam.com/blogs"},{"anchor":"Open Source","href":"https://github.com/wespreadjam/jam-nodes"},{"anchor":"Discord","href":"https://dsc.gg/spreadjam"},{"anchor":"npm","href":"https://www.npmjs.com/org/jam-nodes"}]},"tabs":[{"tab":"GEO for agents","pages":[{"title":"GEO for agents","href":""}]},{"tab":"API Reference","groups":[{"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","description":"One scan's progress: answers collected, failed and still pending per platform, and the collector's task counts. Poll it after `POST /v1/visibility-runs` until `status` is final and `answers.pending` is 0.","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","description":"The active GEO project's Plan, highest priority first, with how many actions are in each status. Superseded actions are left out unless `includeSuperseded=true` or `status` names them. Paged: `limit` (default 100, at most 100) and `cursor`; `pageInfo` says whether more pages follow and `countsByStatus` covers every page. Actions are the Plan: everything research recommends (new pages, page edits, technical fixes, outreach). Opportunities (`/v1/opportunities`) are the article pipeline behind `new_page` actions: when Jam drafts a `new_page` action it creates (or links) an opportunity, and the action carries its `opportunityId`. Work from actions; use opportunities only to write an article yourself from its brief.","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"}]}]},{"tab":"jam-nodes (workflow library)","pages":[{"title":"jam-nodes (workflow library)","href":"/jam-nodes/overview"}]}]},"basePath":"","title":"The credit balance - Jam","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}