The active project’s research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam’s free automatic top-up could run.
Jam's free automatic re-run: at most once a week, after a successful run, once a scan has new answers, and only while the Plan has fewer than 5 untouched article rows. notBefore is when the weekly limit next allows one.
Show child attributes
{"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":[],"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/research/read-the-research-state","slug":"/api-reference/research/read-the-research-state","pageMetadata":{"title":"Read the research state","description":"The active project's research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam's free automatic top-up could run.","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/research","href":"/api-reference/research/read-the-research-state","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 active project’s research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam’s free automatic top-up could run.\"\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":"Read the research state","description":"The active project's research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam's free automatic top-up could run.","deprecated":null,"version":null,"openapi":"https://api.spreadjam.com/openapi.json get /v1/research","href":"/api-reference/research/read-the-research-state","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_research","tags":["Research"],"summary":"Read the research state","description":"The active project's research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam's free automatic top-up could run.","security":["ab444a5e-a236-459b-bd05-a67ecadd9810"],"responses":{"200":"623b7133-3772-4a78-b643-145a380519ba","400":"1d9758ba-d848-4f27-ade7-fae8a086bc41","401":"77dacaa2-0bc8-4603-ab58-5e451095fe9c","404":"8deccb25-e6b5-46e8-9422-68c96d684ae4","429":"1819ebab-24c3-4422-8a88-17b1bb4d5337"},"method":"get","type":"path","servers":["40f652f2-7ec4-407b-8088-5928afe7d79b"],"path":"/v1/research","baseUrlOptions":["https://api.spreadjam.com"],"title":"Read the research state","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"623b7133-3772-4a78-b643-145a380519ba":{"description":"The research state.","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["never","running","done","failed"],"isRequired":true,"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time> | null"},"finishedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"finishedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"finishedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"finishedAt","typeLabel":"string\u003cdate-time> | null"},"latest":{"oneOf":[{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"latest.oneOf.0.requestId","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["first_scan","backfill","manual","top_up"],"description":"`first_scan`: the free run after the first scan. `backfill`: a free run for a project that had none. `manual`: Research again (charged after the first success). `top_up`: Jam's free weekly re-run when the Plan runs low; it only adds rows.","isRequired":true,"uniqueKey":"latest.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"requestedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"latest.oneOf.0.requestedAt","typeLabel":"string\u003cdate-time>"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"latest.oneOf.0.startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"latest.oneOf.0.startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.startedAt","typeLabel":"string\u003cdate-time> | null"},"finishedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"latest.oneOf.0.finishedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"latest.oneOf.0.finishedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.finishedAt","typeLabel":"string\u003cdate-time> | null"},"outcome":{"oneOf":[{"type":"string","enum":["success","failed","abandoned",null],"isRequired":true,"uniqueKey":"latest.oneOf.0.outcome.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["success","failed","abandoned",null],"isRequired":true,"uniqueKey":"latest.oneOf.0.outcome.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.outcome","typeLabel":"enum\u003cstring> | null"},"failureMessage":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"latest.oneOf.0.failureMessage.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"latest.oneOf.0.failureMessage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.failureMessage","typeLabel":"string | null"}},"required":["requestId","kind","requestedAt","startedAt","finishedAt","outcome","failureMessage"],"isRequired":true,"uniqueKey":"latest.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"requestId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["first_scan","backfill","manual","top_up"],"description":"`first_scan`: the free run after the first scan. `backfill`: a free run for a project that had none. `manual`: Research again (charged after the first success). `top_up`: Jam's free weekly re-run when the Plan runs low; it only adds rows."},"requestedAt":{"type":"string","format":"date-time"},"startedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"finishedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"outcome":{"oneOf":[{"type":"string","enum":["success","failed","abandoned",null]},{"type":"null","enum":["success","failed","abandoned",null]}]},"failureMessage":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["requestId","kind","requestedAt","startedAt","finishedAt","outcome","failureMessage"],"isRequired":true,"uniqueKey":"latest.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest","typeLabel":"object | null"},"inFlight":{"oneOf":[{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"inFlight.oneOf.0.requestId","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["first_scan","backfill","manual","top_up"],"description":"`first_scan`: the free run after the first scan. `backfill`: a free run for a project that had none. `manual`: Research again (charged after the first success). `top_up`: Jam's free weekly re-run when the Plan runs low; it only adds rows.","isRequired":true,"uniqueKey":"inFlight.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"requestedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"inFlight.oneOf.0.requestedAt","typeLabel":"string\u003cdate-time>"}},"required":["requestId","kind","requestedAt"],"description":"The run in flight, if any. Runs take about ten minutes.","isRequired":true,"uniqueKey":"inFlight.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"requestId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["first_scan","backfill","manual","top_up"],"description":"`first_scan`: the free run after the first scan. `backfill`: a free run for a project that had none. `manual`: Research again (charged after the first success). `top_up`: Jam's free weekly re-run when the Plan runs low; it only adds rows."},"requestedAt":{"type":"string","format":"date-time"}},"required":["requestId","kind","requestedAt"],"description":"The run in flight, if any. Runs take about ten minutes.","isRequired":true,"uniqueKey":"inFlight.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"inFlight","typeLabel":"object | null"},"manual":{"type":"object","properties":{"eligible":{"type":"boolean","description":"The workspace's plan includes research.","isRequired":true,"uniqueKey":"manual.eligible","typeLabel":"boolean"},"free":{"type":"boolean","description":"The next run is free: the project has never had a successful run.","isRequired":true,"uniqueKey":"manual.free","typeLabel":"boolean"},"credits":{"type":"integer","description":"Credits `POST /v1/research-requests` holds now (kept only if the run succeeds); 0 when free.","isRequired":true,"uniqueKey":"manual.credits","typeLabel":"integer"},"blockedBy":{"oneOf":[{"type":"string","enum":["plan_required","in_progress","first_scan_running",null],"description":"Why a request would be refused now; null when it would be accepted (credits permitting).","isRequired":true,"uniqueKey":"manual.blockedBy.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["plan_required","in_progress","first_scan_running",null],"description":"Why a request would be refused now; null when it would be accepted (credits permitting).","isRequired":true,"uniqueKey":"manual.blockedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"manual.blockedBy","typeLabel":"enum\u003cstring> | null"}},"required":["eligible","free","credits","blockedBy"],"description":"Research again, by hand.","isRequired":true,"uniqueKey":"manual","typeLabel":"object"},"automaticTopUp":{"type":"object","properties":{"eligibleNow":{"type":"boolean","isRequired":true,"uniqueKey":"automaticTopUp.eligibleNow","typeLabel":"boolean"},"notBefore":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"automaticTopUp.notBefore.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"automaticTopUp.notBefore.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"automaticTopUp.notBefore","typeLabel":"string\u003cdate-time> | null"}},"required":["eligibleNow","notBefore"],"description":"Jam's free automatic re-run: at most once a week, after a successful run, once a scan has new answers, and only while the Plan has fewer than 5 untouched article rows. `notBefore` is when the weekly limit next allows one.","isRequired":true,"uniqueKey":"automaticTopUp","typeLabel":"object"}},"required":["state","startedAt","finishedAt","latest","inFlight","manual","automaticTopUp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"state":"never","startedAt":"2023-11-07T05:31:56Z","finishedAt":"2023-11-07T05:31:56Z","latest":{"requestId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"first_scan","requestedAt":"2023-11-07T05:31:56Z","startedAt":"2023-11-07T05:31:56Z","finishedAt":"2023-11-07T05:31:56Z","outcome":"success","failureMessage":"\u003cstring>"},"inFlight":{"requestId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"first_scan","requestedAt":"2023-11-07T05:31:56Z"},"manual":{"eligible":true,"free":true,"credits":123,"blockedBy":"plan_required"},"automaticTopUp":{"eligibleNow":true,"notBefore":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1d9758ba-d848-4f27-ade7-fae8a086bc41":{"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"},"77dacaa2-0bc8-4603-ab58-5e451095fe9c":{"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"},"8deccb25-e6b5-46e8-9422-68c96d684ae4":{"description":"The workspace has no GEO project.","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"},"1819ebab-24c3-4422-8a88-17b1bb4d5337":{"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":{"ab444a5e-a236-459b-bd05-a67ecadd9810":{"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":"Read the research state - Jam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T20:06:51.542Z","originalFileLocation":"api-reference/research/read-the-research-state.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 active project\u0026#x27;s research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam\u0026#x27;s free automatic top-up could run.\">\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=\"Read the research state - Jam\">\u003cmeta data-mint-head property=\"og:description\" content=\"The active project\u0026#x27;s research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam\u0026#x27;s free automatic top-up could run.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Jam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spreadjam.com/api-reference/research/read-the-research-state\">\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=Research\u0026amp;title=Read+the+research+state\u0026amp;description=The+active+project%27s+research%3A+whether+it+is+running%2C+when+the+latest+run+started+and+finished+and+how+it+ended%2C+the+request+in+flight%2C+whether+Research+again+w\u0026amp;theme=d8a8b5752475f2e19d0ccf23\u0026amp;signature=513c6a1bc602aa9d44922880c7cb1bd3499641906ee03b3f8841b698f764a607\">\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=\"Read the research state - Jam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The active project\u0026#x27;s research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam\u0026#x27;s free automatic top-up could run.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jam-36116c1b.mintlify.site/_mintlify/api/og/v2?division=Research\u0026amp;title=Read+the+research+state\u0026amp;description=The+active+project%27s+research%3A+whether+it+is+running%2C+when+the+latest+run+started+and+finished+and+how+it+ended%2C+the+request+in+flight%2C+whether+Research+again+w\u0026amp;theme=d8a8b5752475f2e19d0ccf23\u0026amp;signature=513c6a1bc602aa9d44922880c7cb1bd3499641906ee03b3f8841b698f764a607\">\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/research/read-the-research-state\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/research/read-the-research-state.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/research/read-the-research-state#webpage\",\"url\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state\",\"name\":\"Read the research state\",\"description\":\"The active project's research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam's free automatic top-up could run.\",\"dateModified\":\"2026-11-05T20:06:51.542Z\",\"isPartOf\":{\"@id\":\"https://docs.spreadjam.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Jam\",\"item\":\"https://docs.spreadjam.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read the research state\",\"item\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state#apireference\",\"headline\":\"Read the research state\",\"name\":\"Read the research state\",\"description\":\"The active project's research: whether it is running, when the latest run started and finished and how it ended, the request in flight, whether Research again would be accepted and what it holds (500 credits once the project has a successful run; the first run is free), and whether Jam's free automatic top-up could run.\",\"url\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spreadjam.com/api-reference/research/read-the-research-state#webpage\"},\"dateModified\":\"2026-11-05T20:06:51.542Z\",\"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","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","description":"Ship a `proposed` change: Jam opens its pull request on your connected repository. Holds 20 credits (the Make PR price), kept only if the pull request opens. The change moves to `opening`, then `in_review` with `prUrl`; read it back with `GET /v1/site-changes/{changeId}`. 409 while it is still preparing or once it has moved on; 402 when credits cannot cover it. Requires a paid plan.","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","description":"What the latest successful research run found: how many AI answers it read and every action it proposed, best first, with its why, evidence (`details`, `sources`) and the prompts it targets. `report` is null before any run succeeded. Each action is also at `GET /v1/actions/{id}` with its `agentPrompt`.","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":"Read the research state - 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"]}