{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Almanac API","description":"Read, generate, and refresh researched profile articles with the Almanac API.","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/ycpedia/F_OYgOuEwElT8RrX/logomark-light.svg?fit=max\u0026auto=format\u0026n=F_OYgOuEwElT8RrX\u0026q=85\u0026s=a6a16e18423a03302e009e6ce2327c81","dark":"https://mintcdn.com/ycpedia/F_OYgOuEwElT8RrX/logomark-dark.svg?fit=max\u0026auto=format\u0026n=F_OYgOuEwElT8RrX\u0026q=85\u0026s=5e2e049142c7093f31758e7f4592c543","href":"/"},"favicon":{"light":"https://mintcdn.com/ycpedia/Urw17iuJabiBpbyI/images/almanac-icon.svg?fit=max\u0026auto=format\u0026n=Urw17iuJabiBpbyI\u0026q=85\u0026s=95fdd7a3dc3364ff8733b3e2acc59604","dark":"https://mintcdn.com/ycpedia/Urw17iuJabiBpbyI/images/almanac-icon-dark.svg?fit=max\u0026auto=format\u0026n=Urw17iuJabiBpbyI\u0026q=85\u0026s=191dbacb3214f5b0559faac971eecdcd"},"api":{"openapi":"openapi.json"},"seo":{"metatags":{"og:site_name":"Almanac API","og:type":"website","og:image":"https://docs.ycpedia.org/images/almanac-api-social-20260918-v2.png","og:image:alt":"Almanac API — Read, generate, and refresh researched profile articles.","twitter:card":"summary_large_image","twitter:image":"https://docs.ycpedia.org/images/almanac-api-social-20260918-v2.png","twitter:image:alt":"Almanac API — Read, generate, and refresh researched profile articles.","application-name":"Almanac API","apple-mobile-web-app-title":"Almanac API","canonical":"https://docs.ycpedia.org"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ycpedia","hasAudioNarration":false,"actualSubdomain":"ycpedia","customDomains":["docs.ycpedia.org"],"gitSource":{"type":"github","owner":"reverieone","repo":"almanac-backend","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aadc166a91cdf5660704382","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API reference","count":6},{"language":"default","tag":"Get started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/update","slug":"/api-reference/update","pageMetadata":{"title":"Update an article","openapi":"POST /api/v1/articles/{linkedin_id}/update","description":"Refresh an existing profile article with new research through the Almanac API.","href":"/api-reference/update"},"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: \"Refresh an existing profile article with new research through the Almanac API.\"\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":{"config":{},"pageMetadata":{"title":"Update an article","openapi":"POST /api/v1/articles/{linkedin_id}/update","description":"Refresh an existing profile article with new research through the Almanac API.","href":"/api-reference/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update an article","description":"Refresh an existing profile article with new research through the Almanac API.","operationId":"update_an_article","responses":{"200":"f8e7cd07-5be5-4cf2-81f4-573054567c9c","202":"ff3daa82-80d8-48cc-8229-daf230f5e8ec","401":"faa63ef7-a9eb-4ca4-8830-47b2ca718454","402":"49d95e6e-a899-4c2c-b2bd-bd36d00b6b06","404":"5c94c270-b360-43ea-b317-1de9be9c2afa","409":"f7bec391-163e-4b1d-99f2-4713ff831803","422":"f91cc62c-9f8a-4864-b1ef-2c031052c717","429":"2ec8ed96-474f-4982-9305-fe0d0280312a"},"security":["a53b3449-72e1-47ed-98c3-c064e795a86b"],"parameters":["065f4e51-7d66-4133-b5ee-79d635735490","46c08bad-4965-479b-a8fa-8ac54b5bba10"],"method":"post","type":"path","servers":["4d1e7e4c-3dc8-414b-9922-ff54396f8984"],"path":"/api/v1/articles/{linkedin_id}/update","baseUrlOptions":["https://api.thealmanac.ai"],"title":"Update an article","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"065f4e51-7d66-4133-b5ee-79d635735490":{"name":"linkedin_id","in":"path","required":true,"description":"The slug after linkedin.com/in/, for example jane-doe.","schema":{"type":"string","isRequired":true,"description":"The slug after linkedin.com/in/, for example jane-doe.","uniqueKey":"","typeLabel":"string"}},"46c08bad-4965-479b-a8fa-8ac54b5bba10":{"name":"Idempotency-Key","in":"header","required":true,"description":"A unique value for this operation. Reuse it when retrying the same request to avoid duplicate charges.","schema":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"description":"A unique value for this operation. Reuse it when retrying the same request to avoid duplicate charges.","uniqueKey":"","typeLabel":"string"}}},"responses":{"f8e7cd07-5be5-4cf2-81f4-573054567c9c":{"description":"Success","content":{"application/json":{"schema":{"properties":{"job_id":{"format":"uuid","title":"Job Id","type":"string","isRequired":true,"uniqueKey":"job_id","typeLabel":"string\u003cuuid>"},"linkedin_id":{"title":"Linkedin Id","type":"string","examples":["jane-doe"],"isRequired":true,"uniqueKey":"linkedin_id","typeLabel":"string"},"status":{"enum":["queued","running","succeeded","failed","cancelled"],"title":"Status","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"credits_charged":{"title":"Credits Charged","type":"integer","description":"Credits reserved or charged for this operation. Returns 0 after a failed or cancelled job is refunded.","examples":[100],"isRequired":true,"uniqueKey":"credits_charged","typeLabel":"integer"},"article":{"oneOf":[{"type":"object","title":"ApiArticle","required":["article_id","title","content","sources","infobox","current_version","created_at","updated_at"],"properties":{"article_id":{"title":"Article Id","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.article_id","typeLabel":"string"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.title","typeLabel":"string"},"content":{"title":"Content","type":"string","description":"Article text with its original formatting and citation references.","isRequired":true,"uniqueKey":"article.oneOf.0.content","typeLabel":"string"},"sources":{"items":{"properties":{"id":{"title":"Id","type":"integer","isRequired":true,"uniqueKey":"article.oneOf.0.sources.items.[INDEX].id","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.sources.items.[INDEX].title","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Url","uniqueKey":"article.oneOf.0.sources.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","uniqueKey":"article.oneOf.0.sources.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].url","typeLabel":"string | null"},"publication":{"oneOf":[{"type":"string","title":"Publication","uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication.oneOf.0","typeLabel":"string"},{"type":"null","title":"Publication","uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication","typeLabel":"string | null"},"excerpt":{"oneOf":[{"type":"string","title":"Excerpt","uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Excerpt","uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt","typeLabel":"string | null"}},"required":["id","title"],"title":"ApiSource","type":"object","uniqueKey":"article.oneOf.0.sources.items.[INDEX]","typeLabel":"ApiSource · object"},"title":"Sources","type":"array","isRequired":true,"uniqueKey":"article.oneOf.0.sources","typeLabel":"ApiSource · object[]"},"infobox":{"oneOf":[{"type":"object","title":"Infobox","description":"Available profile metadata. Keys vary by article; may be null.","additionalProperties":true,"isRequired":true,"uniqueKey":"article.oneOf.0.infobox.oneOf.0","typeLabel":"Infobox · object"},{"type":"null","title":"Infobox","description":"Available profile metadata. Keys vary by article; may be null.","isRequired":true,"uniqueKey":"article.oneOf.0.infobox.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"article.oneOf.0.infobox","typeLabel":"Infobox · object | null"},"current_version":{"title":"Current Version","type":"integer","examples":[1],"isRequired":true,"uniqueKey":"article.oneOf.0.current_version","typeLabel":"integer"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","title":"Updated At","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"article.oneOf.0","typeLabel":"ApiArticle · object"},{"type":"null","uniqueKey":"article.oneOf.1","typeLabel":"null"}],"uniqueKey":"article","typeLabel":"ApiArticle · object | null"},"error":{"oneOf":[{"type":"string","title":"Error","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["job_id","linkedin_id","status","credits_charged"],"title":"ApiJobResponse","type":"object","uniqueKey":"","typeLabel":"ApiJobResponse · object"},"examples":{"Example":{"title":"Example","value":{"job_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","linkedin_id":"jane-doe","status":"queued","credits_charged":100,"article":{"article_id":"\u003cstring>","title":"\u003cstring>","content":"\u003cstring>","sources":[{"id":123,"title":"\u003cstring>","url":"\u003cstring>","publication":"\u003cstring>","excerpt":"\u003cstring>"}],"infobox":{},"current_version":1,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ff3daa82-80d8-48cc-8229-daf230f5e8ec":{"description":"Generation queued or running. Poll the returned job_id for free.","content":{"application/json":{"schema":{"properties":{"job_id":{"format":"uuid","title":"Job Id","type":"string","isRequired":true,"uniqueKey":"job_id","typeLabel":"string\u003cuuid>"},"linkedin_id":{"title":"Linkedin Id","type":"string","examples":["jane-doe"],"isRequired":true,"uniqueKey":"linkedin_id","typeLabel":"string"},"status":{"enum":["queued","running","succeeded","failed","cancelled"],"title":"Status","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"credits_charged":{"title":"Credits Charged","type":"integer","description":"Credits reserved or charged for this operation. Returns 0 after a failed or cancelled job is refunded.","examples":[100],"isRequired":true,"uniqueKey":"credits_charged","typeLabel":"integer"},"article":{"oneOf":[{"type":"object","title":"ApiArticle","required":["article_id","title","content","sources","infobox","current_version","created_at","updated_at"],"properties":{"article_id":{"title":"Article Id","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.article_id","typeLabel":"string"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.title","typeLabel":"string"},"content":{"title":"Content","type":"string","description":"Article text with its original formatting and citation references.","isRequired":true,"uniqueKey":"article.oneOf.0.content","typeLabel":"string"},"sources":{"items":{"properties":{"id":{"title":"Id","type":"integer","isRequired":true,"uniqueKey":"article.oneOf.0.sources.items.[INDEX].id","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.sources.items.[INDEX].title","typeLabel":"string"},"url":{"oneOf":[{"type":"string","title":"Url","uniqueKey":"article.oneOf.0.sources.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","uniqueKey":"article.oneOf.0.sources.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].url","typeLabel":"string | null"},"publication":{"oneOf":[{"type":"string","title":"Publication","uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication.oneOf.0","typeLabel":"string"},{"type":"null","title":"Publication","uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].publication","typeLabel":"string | null"},"excerpt":{"oneOf":[{"type":"string","title":"Excerpt","uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Excerpt","uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt.oneOf.1","typeLabel":"null"}],"uniqueKey":"article.oneOf.0.sources.items.[INDEX].excerpt","typeLabel":"string | null"}},"required":["id","title"],"title":"ApiSource","type":"object","uniqueKey":"article.oneOf.0.sources.items.[INDEX]","typeLabel":"ApiSource · object"},"title":"Sources","type":"array","isRequired":true,"uniqueKey":"article.oneOf.0.sources","typeLabel":"ApiSource · object[]"},"infobox":{"oneOf":[{"type":"object","title":"Infobox","description":"Available profile metadata. Keys vary by article; may be null.","additionalProperties":true,"isRequired":true,"uniqueKey":"article.oneOf.0.infobox.oneOf.0","typeLabel":"Infobox · object"},{"type":"null","title":"Infobox","description":"Available profile metadata. Keys vary by article; may be null.","isRequired":true,"uniqueKey":"article.oneOf.0.infobox.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"article.oneOf.0.infobox","typeLabel":"Infobox · object | null"},"current_version":{"title":"Current Version","type":"integer","examples":[1],"isRequired":true,"uniqueKey":"article.oneOf.0.current_version","typeLabel":"integer"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","title":"Updated At","type":"string","isRequired":true,"uniqueKey":"article.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"article.oneOf.0","typeLabel":"ApiArticle · object"},{"type":"null","uniqueKey":"article.oneOf.1","typeLabel":"null"}],"uniqueKey":"article","typeLabel":"ApiArticle · object | null"},"error":{"oneOf":[{"type":"string","title":"Error","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["job_id","linkedin_id","status","credits_charged"],"title":"ApiJobResponse","type":"object","uniqueKey":"","typeLabel":"ApiJobResponse · object"},"examples":{"Example":{"title":"Example","value":{"job_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","linkedin_id":"jane-doe","status":"queued","credits_charged":100,"article":{"article_id":"\u003cstring>","title":"\u003cstring>","content":"\u003cstring>","sources":[{"id":123,"title":"\u003cstring>","url":"\u003cstring>","publication":"\u003cstring>","excerpt":"\u003cstring>"}],"infobox":{},"current_version":1,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"faa63ef7-a9eb-4ca4-8830-47b2ca718454":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"49d95e6e-a899-4c2c-b2bd-bd36d00b6b06":{"description":"Insufficient credits. Buy credits before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5c94c270-b360-43ea-b317-1de9be9c2afa":{"description":"Profile or job not found, unavailable, or inaccessible.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f7bec391-163e-4b1d-99f2-4713ff831803":{"description":"Another job is active for this profile, or the idempotency key was used for a different operation.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f91cc62c-9f8a-4864-b1ef-2c031052c717":{"description":"Invalid request or missing Idempotency-Key.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2ec8ed96-474f-4982-9305-fe0d0280312a":{"description":"Rate limit exceeded. Wait for the Retry-After duration.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | object[]"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","example":60}}},"exampleType":"generated"}},"security":{"a53b3449-72e1-47ed-98c3-c064e795a86b":{"CustomerApiKey":{"type":"http","scheme":"bearer","description":"Your customer API key (alm_…). Keep it on your server.","scopes":[]}}},"servers":{"4d1e7e4c-3dc8-414b-9922-ff54396f8984":{"url":"https://api.thealmanac.ai","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your customer API key (alm_…). Keep it on your server.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your customer API key (alm_…). Keep it on your server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"CustomerApiKey","name":"Authorization"}],"title":"CustomerApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"ycpedia","siteName":"Almanac API","title":"Update an article - Almanac API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-18T22:55:40.311Z","originalFileLocation":"api-reference/update.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Refresh an existing profile article with new research through the Almanac API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Almanac API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_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/ycpedia/WWN2amIy824cR6MO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an article - Almanac API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Refresh an existing profile article with new research through the Almanac API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Almanac API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ycpedia.org/api-reference/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.ycpedia.org/images/almanac-api-social-20260918-v2.png\">\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=\"Update an article - Almanac API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Refresh an existing profile article with new research through the Almanac API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.ycpedia.org/images/almanac-api-social-20260918-v2.png\">\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/ycpedia/WWN2amIy824cR6MO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Almanac API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Almanac API — Read, generate, and refresh researched profile articles.\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Almanac API — Read, generate, and refresh researched profile articles.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Almanac API\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ycpedia.org/api-reference/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ycpedia.org/#organization\",\"name\":\"Almanac API\",\"url\":\"https://docs.ycpedia.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ycpedia/F_OYgOuEwElT8RrX/logomark-light.svg?fit=max\u0026auto=format\u0026n=F_OYgOuEwElT8RrX\u0026q=85\u0026s=a6a16e18423a03302e009e6ce2327c81\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ycpedia.org#website\",\"name\":\"Almanac API\",\"url\":\"https://docs.ycpedia.org\",\"publisher\":{\"@id\":\"https://docs.ycpedia.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ycpedia.org/api-reference/update#webpage\",\"url\":\"https://docs.ycpedia.org/api-reference/update\",\"name\":\"Update an article\",\"description\":\"Refresh an existing profile article with new research through the Almanac API.\",\"dateModified\":\"2026-09-18T22:55:40.311Z\",\"isPartOf\":{\"@id\":\"https://docs.ycpedia.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ycpedia.org/api-reference/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ycpedia.org/api-reference/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.ycpedia.org/api-reference/read\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update an article\",\"item\":\"https://docs.ycpedia.org/api-reference/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ycpedia.org/api-reference/update#apireference\",\"headline\":\"Update an article\",\"name\":\"Update an article\",\"description\":\"Refresh an existing profile article with new research through the Almanac API.\",\"url\":\"https://docs.ycpedia.org/api-reference/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ycpedia.org/api-reference/update#webpage\"},\"image\":\"https://docs.ycpedia.org/images/almanac-api-social-20260918-v2.png\",\"dateModified\":\"2026-09-18T22:55:40.311Z\",\"publisher\":{\"@id\":\"https://docs.ycpedia.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ycpedia.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Almanac API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Almanac API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/update.md","siteName":"Almanac API","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"Credits and retries","href":"/credits-and-retries"},{"title":"For agents","href":"/agents"}]},{"group":"API reference","pages":[{"title":"Read an article","openapi":"GET /api/v1/articles/{linkedin_id}","href":"/api-reference/read"},{"title":"Generate an article","openapi":"POST /api/v1/articles","description":"Create a new profile article with the Almanac API. Existing profiles return article_exists without a charge.","href":"/api-reference/generate"},{"title":"Update an article","openapi":"POST /api/v1/articles/{linkedin_id}/update","href":"/api-reference/update"},{"title":"Get a job","openapi":"GET /api/v1/jobs/{job_id}","description":"Check an Almanac API generation or update job and retrieve its completed article result.","href":"/api-reference/job"},{"title":"Get credit balance","openapi":"GET /api/v1/credits","href":"/api-reference/balance"},{"title":"Buy credits","openapi":"POST /api/v1/credits/checkout","href":"/api-reference/checkout"}]}]},"basePath":"","title":"Update an article - Almanac API","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}