Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to ‘add’ (with name) to propose a new entity, or ‘refine’ (with the target entity oId) to propose changes to an existing one.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Octave API","colors":{"primary":"#333999","light":"#4B53C3","dark":"#3D3299"},"logo":{"light":"https://mintcdn.com/octave/SNMu0rTVOCvjTqcW/logo/logo.svg?fit=max\u0026auto=format\u0026n=SNMu0rTVOCvjTqcW\u0026q=85\u0026s=4f2d9698f4a42a583deee9e8721a9211","dark":"https://mintcdn.com/octave/SNMu0rTVOCvjTqcW/logo/logo.svg?fit=max\u0026auto=format\u0026n=SNMu0rTVOCvjTqcW\u0026q=85\u0026s=4f2d9698f4a42a583deee9e8721a9211"},"favicon":"https://mintcdn.com/octave/SNMu0rTVOCvjTqcW/favicon.svg?fit=max\u0026auto=format\u0026n=SNMu0rTVOCvjTqcW\u0026q=85\u0026s=f2d2b56c810a0fd21cf18ef023ddfab4","api":{"mdx":{"auth":{"method":"key","name":"api_key"}}},"navbar":{"links":[{"href":"mailto:support@octavehq.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.octavehq.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/octavehq"}},"seo":{"metatags":{"og:site_name":"Octave API Documentation","og:type":"website","og:locale":"en_US"},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-QW3B8BG664"},"posthog":{"apiKey":"phc_J3I5lz22TVmvufdByV6yBKkp0FTbjAAR9LiYPX7ss7k","apiHost":"https://us.i.posthog.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"octave","hasAudioNarration":false,"actualSubdomain":"octave","customDomains":["docs.octavehq.com"],"gitSource":{"type":"github","owner":"octavehq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad29841669989d80e4e39e5","collectionId":"87662524-ef0d-4143-8068-3bcc32f9f084","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad29841669989d80e4e39e5"},"entitlements":{},"buildId":"6ad29841669989d80e4e39e5","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"V2 API Reference","count":250},{"language":"default","tag":"Getting Started","count":45},{"language":"default","tag":"Concepts","count":29},{"language":"default","tag":"Asset","count":23},{"language":"default","tag":"Agents","count":18},{"language":"default","tag":"MCP","count":12},{"language":"default","tag":"Events","count":11},{"language":"default","tag":"Custom Extractors","count":10},{"language":"default","tag":"Sources","count":8},{"language":"default","tag":"Data warehouse","count":8}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2-api-reference/suggestions/create-suggestion","slug":"/v2-api-reference/suggestions/create-suggestion","pageMetadata":{"openapi":"post /api/v2/suggestion/create","title":"Create Suggestion","description":"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to 'add' (with name) to propose a new entity, or 'refine' (with the target entity oId) to propose changes to an existing one.","href":"/v2-api-reference/suggestions/create-suggestion"},"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: \"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to ‘add’ (with name) to propose a new entity, or ‘refine’ (with the target entity oId) to propose changes to an existing one.\"\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":{"openapi":"post /api/v2/suggestion/create","title":"Create Suggestion","description":"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to 'add' (with name) to propose a new entity, or 'refine' (with the target entity oId) to propose changes to an existing one.","href":"/v2-api-reference/suggestions/create-suggestion"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/octave/ad2757b864166314/schema.js"],"openApiReferenceData":{"operation":{"deprecated":false,"operationId":"createSuggestion","summary":"Create Suggestion","description":"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to 'add' (with name) to propose a new entity, or 'refine' (with the target entity oId) to propose changes to an existing one.","tags":["Suggestions"],"x-visibility":"public","requestBody":"37166c21-22d1-4124-b159-60ecd0a9c08f","responses":{"200":"0300bd13-8d46-43dc-963b-c4ac67983e4a","400":"967b96dd-a7cf-47eb-84d7-0674f27b756a","403":"308f8b4b-cea4-4de1-b82b-95fcaa77c0d7"},"method":"post","type":"path","servers":["80f2e4ba-6bdd-4b60-98d6-f0697e937bc7"],"security":["488bd04d-b181-41af-8ce0-a9e9dcfaa69b"],"path":"/api/v2/suggestion/create","baseUrlOptions":["https://app.octavehq.com"],"title":"Create Suggestion","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"changeType":{"type":"string","enum":["add","refine"],"description":"'add' proposes a brand new entity; 'refine' proposes changes to an existing one.","example":"add","isRequired":true,"uniqueKey":"changeType","typeLabel":"enum\u003cstring>"},"entityType":{"type":"string","enum":["persona","product","segment","use_case","competitor","alternative","buying_trigger","core_feature","objection","proof_point","reference","service","solution","brand_voice"],"description":"Library entity type: persona, product, segment, use_case, competitor, alternative, buying_trigger, objection, proof_point, reference, service, solution, brand_voice.","example":"persona","isRequired":true,"uniqueKey":"entityType","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"Detailed natural-language description of what to add or change, and why.","isRequired":true,"uniqueKey":"instructions","typeLabel":"string"},"name":{"type":"string","description":"Name of the new entity. Required when changeType is 'add'.","uniqueKey":"name","typeLabel":"string"},"oId":{"type":"string","description":"oId of the entity to refine (from the entity list endpoints). Required when changeType is 'refine'.","uniqueKey":"oId","typeLabel":"string"},"keyContext":{"type":"string","description":"Additional background text to inform the proposal.","uniqueKey":"keyContext","typeLabel":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["url","text"],"description":"Source type: 'url' for web pages, 'text' for raw content","isRequired":true,"uniqueKey":"sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"content":{"type":"string","description":"The URL to fetch or the text content","isRequired":true,"uniqueKey":"sources.items.[INDEX].content","typeLabel":"string"}},"required":["type","content"],"uniqueKey":"sources.items.[INDEX]","typeLabel":"object"},"description":"Optional source materials (URLs to fetch, or raw text) to inform the proposal.","uniqueKey":"sources","typeLabel":"object[]"}},"required":["changeType","entityType","instructions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"changeType":"add","entityType":"persona","instructions":"\u003cstring>","name":"\u003cstring>","oId":"\u003cstring>","keyContext":"\u003cstring>","sources":[{"content":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0300bd13-8d46-43dc-963b-c4ac67983e4a":{"description":"The queued pending suggestion","content":{"application/json":{"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"requestId":{"type":"string","example":"requestId","description":"Request ID","isRequired":true,"uniqueKey":"_metadata.requestId","typeLabel":"string"},"timestamp":{"type":"string","example":"2021-01-01T00:00:00.000Z","description":"Timestamp","isRequired":true,"uniqueKey":"_metadata.timestamp","typeLabel":"string"},"usage":{"type":"number","default":0,"example":0,"description":"API usage","uniqueKey":"_metadata.usage","typeLabel":"number"},"message":{"type":"string","example":"message","description":"Message","uniqueKey":"_metadata.message","typeLabel":"string"}},"required":["requestId","timestamp"],"isRequired":true,"uniqueKey":"_metadata","typeLabel":"object"},"data":{"type":"object","required":["groupOId","message","oId","status","changeType","suggestionType","targetEntityType","targetEntityOId"],"properties":{"oId":{"type":"string","description":"The suggestion's oId.","isRequired":true,"uniqueKey":"data.oId","typeLabel":"string"},"status":{"type":"string","enum":["draft","pending","accepted","rejected","dismissed","expired"],"description":"Lifecycle status after the operation.","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"changeType":{"type":"string","enum":["add","refine"],"description":"Friendly framing of the change: 'add' creates a brand new library entity; 'refine' changes an existing one.","example":"add","isRequired":true,"uniqueKey":"data.changeType","typeLabel":"enum\u003cstring>"},"suggestionType":{"type":"string","enum":["create_entity","update_entity","generate_entity","refine_entity","link_entities"],"description":"The raw underlying suggestion type.","isRequired":true,"uniqueKey":"data.suggestionType","typeLabel":"enum\u003cstring>"},"targetEntityType":{"type":"string","enum":["Product","Service","Solution","Persona","UseCase","Reference","Segment","Competitor","Alternative","BuyingTrigger","CoreFeature","Objection","ProofPoint","Playbook","Agent","Hypothesis","BrandVoice","Resource"],"description":"The library entity type being added or refined.","isRequired":true,"uniqueKey":"data.targetEntityType","typeLabel":"enum\u003cstring>"},"targetEntityOId":{"oneOf":[{"type":"string","description":"oId of the entity being refined (null for 'add').","isRequired":true,"uniqueKey":"data.targetEntityOId.oneOf.0","typeLabel":"string"},{"type":"null","description":"oId of the entity being refined (null for 'add').","isRequired":true,"uniqueKey":"data.targetEntityOId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.targetEntityOId","typeLabel":"string | null"},"groupOId":{"type":"string","description":"oId of the suggestion group the proposal was queued into.","isRequired":true,"uniqueKey":"data.groupOId","typeLabel":"string"},"message":{"type":"string","description":"Human-readable confirmation of what was queued.","isRequired":true,"uniqueKey":"data.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["_metadata","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_metadata":{"requestId":"requestId","timestamp":"2021-01-01T00:00:00.000Z","usage":0,"message":"message"},"data":{"oId":"\u003cstring>","status":"draft","changeType":"add","suggestionType":"create_entity","targetEntityType":"Product","targetEntityOId":"\u003cstring>","groupOId":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"967b96dd-a7cf-47eb-84d7-0674f27b756a":{"description":"Missing required field for the change type (name for 'add', oId for 'refine'), or invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"requestId":{"type":"string","example":"requestId","description":"Request ID","isRequired":true,"uniqueKey":"_metadata.requestId","typeLabel":"string"},"timestamp":{"type":"string","example":"2021-01-01T00:00:00.000Z","description":"Timestamp","isRequired":true,"uniqueKey":"_metadata.timestamp","typeLabel":"string"},"usage":{"type":"number","default":0,"example":0,"description":"API usage","uniqueKey":"_metadata.usage","typeLabel":"number"},"message":{"type":"string","example":"message","description":"Message","uniqueKey":"_metadata.message","typeLabel":"string"}},"required":["requestId","timestamp"],"isRequired":true,"uniqueKey":"_metadata","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["_metadata","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_metadata":{"requestId":"requestId","timestamp":"2021-01-01T00:00:00.000Z","usage":0,"message":"message"},"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"308f8b4b-cea4-4de1-b82b-95fcaa77c0d7":{"description":"Plan does not include this entity type","content":{"application/json":{"schema":{"type":"object","properties":{"_metadata":{"type":"object","properties":{"requestId":{"type":"string","example":"requestId","description":"Request ID","isRequired":true,"uniqueKey":"_metadata.requestId","typeLabel":"string"},"timestamp":{"type":"string","example":"2021-01-01T00:00:00.000Z","description":"Timestamp","isRequired":true,"uniqueKey":"_metadata.timestamp","typeLabel":"string"},"usage":{"type":"number","default":0,"example":0,"description":"API usage","uniqueKey":"_metadata.usage","typeLabel":"number"},"message":{"type":"string","example":"message","description":"Message","uniqueKey":"_metadata.message","typeLabel":"string"}},"required":["requestId","timestamp"],"isRequired":true,"uniqueKey":"_metadata","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["_metadata","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_metadata":{"requestId":"requestId","timestamp":"2021-01-01T00:00:00.000Z","usage":0,"message":"message"},"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"488bd04d-b181-41af-8ce0-a9e9dcfaa69b":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api_key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"80f2e4ba-6bdd-4b60-98d6-f0697e937bc7":{"url":"https://app.octavehq.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api_key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"api_key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"api_key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"v2-api-reference/openapi.json"},"subdomain":"octave","siteName":"Octave API","title":"Create Suggestion - Octave API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-22T21:54:09.622Z","originalFileLocation":"v2-api-reference/suggestions/create-suggestion.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=\"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to \u0026#x27;add\u0026#x27; (with name) to propose a new entity, or \u0026#x27;refine\u0026#x27; (with the target entity oId) to propose changes to an existing one.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Octave 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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_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/octave/FIdKYiabDumANUaD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Suggestion - Octave API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to \u0026#x27;add\u0026#x27; (with name) to propose a new entity, or \u0026#x27;refine\u0026#x27; (with the target entity oId) to propose changes to an existing one.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Octave API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://octave.mintlify.app/_mintlify/api/og/v2?division=Suggestions\u0026amp;title=Create+Suggestion\u0026amp;description=Queue+a+PENDING+entity+suggestion+for+human+review.+This+does+NOT+create+or+modify+any+library+entity+%E2%80%94+it+produces+a+proposal+that+must+be+explicitly+accepted+\u0026amp;theme=7aca23396e4d7872f604e192\u0026amp;signature=cdc6193200c545efbf80517226ccb078a4549a9c7321c34f202517f5c30dea9f\">\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=\"Create Suggestion - Octave API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to \u0026#x27;add\u0026#x27; (with name) to propose a new entity, or \u0026#x27;refine\u0026#x27; (with the target entity oId) to propose changes to an existing one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://octave.mintlify.app/_mintlify/api/og/v2?division=Suggestions\u0026amp;title=Create+Suggestion\u0026amp;description=Queue+a+PENDING+entity+suggestion+for+human+review.+This+does+NOT+create+or+modify+any+library+entity+%E2%80%94+it+produces+a+proposal+that+must+be+explicitly+accepted+\u0026amp;theme=7aca23396e4d7872f604e192\u0026amp;signature=cdc6193200c545efbf80517226ccb078a4549a9c7321c34f202517f5c30dea9f\">\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/octave/FIdKYiabDumANUaD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Octave API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#333999\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2-api-reference/suggestions/create-suggestion.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.octavehq.com/#organization\",\"name\":\"Octave API\",\"url\":\"https://docs.octavehq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/octave/SNMu0rTVOCvjTqcW/logo/logo.svg?fit=max\u0026auto=format\u0026n=SNMu0rTVOCvjTqcW\u0026q=85\u0026s=4f2d9698f4a42a583deee9e8721a9211\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.octavehq.com#website\",\"name\":\"Octave API\",\"url\":\"https://docs.octavehq.com\",\"publisher\":{\"@id\":\"https://docs.octavehq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion#webpage\",\"url\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion\",\"name\":\"Create Suggestion\",\"description\":\"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to 'add' (with name) to propose a new entity, or 'refine' (with the target entity oId) to propose changes to an existing one.\",\"dateModified\":\"2026-07-22T21:54:09.622Z\",\"isPartOf\":{\"@id\":\"https://docs.octavehq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Suggestions\",\"item\":\"https://docs.octavehq.com/v2-api-reference/suggestions/list-suggestions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Suggestion\",\"item\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion#apireference\",\"headline\":\"Create Suggestion\",\"name\":\"Create Suggestion\",\"description\":\"Queue a PENDING entity suggestion for human review. This does NOT create or modify any library entity — it produces a proposal that must be explicitly accepted (via suggestion/accept or the Suggestions inbox) before anything changes. Set changeType to 'add' (with name) to propose a new entity, or 'refine' (with the target entity oId) to propose changes to an existing one.\",\"url\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octavehq.com/v2-api-reference/suggestions/create-suggestion#webpage\"},\"dateModified\":\"2026-07-22T21:54:09.622Z\",\"publisher\":{\"@id\":\"https://docs.octavehq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.octavehq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Octave API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Octave API","nav":{"global":null,"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/introduction"}]},{"tab":"V2 API Reference","groups":[{"group":"Agents","pages":[{"openapi":"get /api/v2/agents/list","title":"List Agents","href":"/v2-api-reference/agents/list-agents"},{"openapi":"get /api/v2/agents/types","title":"List Agent Types","href":"/v2-api-reference/agents/list-agent-types"},{"openapi":"get /api/v2/agents/languages","title":"List Languages","href":"/v2-api-reference/agents/list-languages"},{"openapi":"get /api/v2/agents/get","title":"Get Agent","href":"/v2-api-reference/agents/get-agent"},{"openapi":"post /api/v2/agents/create","title":"Create Agent","href":"/v2-api-reference/agents/create-agent"},{"openapi":"post /api/v2/agents/update","title":"Update Agent","href":"/v2-api-reference/agents/update-agent"},{"openapi":"delete /api/v2/agents/delete","title":"Delete Agent","href":"/v2-api-reference/agents/delete-agent"},{"openapi":"post /api/v2/agents/experiment/create","title":"Create Agent Experiment","href":"/v2-api-reference/agents/create-agent-experiment"},{"openapi":"post /api/v2/agents/enrich-company/run","title":"Enrich Company Agent","href":"/v2-api-reference/agents/enrich-company-agent"},{"openapi":"post /api/v2/agents/enrich-person/run","title":"Enrich Person Agent","href":"/v2-api-reference/agents/enrich-person-agent"},{"openapi":"post /api/v2/agents/generate-content/run","title":"Content Agent","href":"/v2-api-reference/agents/content-agent"},{"openapi":"post /api/v2/agents/sequence/run","title":"Sequence Agent","href":"/v2-api-reference/agents/sequence-agent"},{"openapi":"post /api/v2/agents/prospector/run","title":"Prospector Agent","href":"/v2-api-reference/agents/prospector-agent"},{"openapi":"post /api/v2/agents/qualify-person/run","title":"Qualify Person Agent","href":"/v2-api-reference/agents/qualify-person-agent"},{"openapi":"post /api/v2/agents/qualify-company/run","title":"Qualify Company Agent","href":"/v2-api-reference/agents/qualify-company-agent"},{"openapi":"post /api/v2/agents/call-prep/run","title":"Call Prep Agent","href":"/v2-api-reference/agents/call-prep-agent"},{"openapi":"post /api/v2/agents/context/run","title":"Context Agent Run","href":"/v2-api-reference/agents/context-agent-run"},{"openapi":"post /api/v2/agents/workspace/build","title":"Workspace Builder Agent","href":"/v2-api-reference/agents/workspace-builder-agent"}]},{"group":"Async","pages":[{"openapi":"post /api/v2/async/agent/run","title":"Run Agents","href":"/v2-api-reference/async/run-agent"},{"openapi":"get /api/v2/async/agent/run/status","title":"Get Async Agent Run Status","href":"/v2-api-reference/async/get-async-agent-run-status"},{"openapi":"post /api/v2/async/headless/generate-emails","title":"Generate Emails","href":"/v2-api-reference/async/generate-emails"}]},{"group":"Runs","pages":[{"openapi":"post /api/v2/skills/{key}/runs","title":"Run a skill","href":"/v2-api-reference/run/run-a-skill"},{"openapi":"get /api/v2/runs/{oId}","title":"Get a run","href":"/v2-api-reference/run/get-a-run"},{"openapi":"post /api/v2/runs/{oId}/cancel","title":"Cancel a run","href":"/v2-api-reference/run/cancel-a-run"}]},{"group":"Workspace","pages":[{"openapi":"post /api/v2/agents/workspace/build","title":"Workspace Builder Agent","href":"/v2-api-reference/workspace/build"}]},{"group":"Research","pages":[{"openapi":"post /api/v2/person/resolve-profile","title":"Resolve Profile from Email","href":"/v2-api-reference/research/resolve-profile-from-email"},{"openapi":"post /api/v2/person/resolve-email","title":"Resolve Email from Profile","href":"/v2-api-reference/research/resolve-email-from-profile"}]},{"group":"API Key","pages":[{"openapi":"get /api/v2/api-key/list","title":"List API keys","href":"/v2-api-reference/api-key/list-api-keys"},{"openapi":"get /api/v2/api-key/validate","title":"Validate API key","href":"/v2-api-reference/api-key/validate-api-key"}]},{"group":"Entity Webhooks","pages":[{"openapi":"get /api/v2/entity-webhook/list","title":"List entity webhook endpoints","href":"/v2-api-reference/entity-webhooks/list-entity-webhook-endpoints"},{"openapi":"post /api/v2/entity-webhook/create","title":"Create an entity webhook endpoint","href":"/v2-api-reference/entity-webhooks/create-an-entity-webhook-endpoint"},{"openapi":"post /api/v2/entity-webhook/update","title":"Update an entity webhook endpoint","href":"/v2-api-reference/entity-webhooks/update-an-entity-webhook-endpoint"},{"openapi":"delete /api/v2/entity-webhook/delete","title":"Delete an entity webhook endpoint","href":"/v2-api-reference/entity-webhooks/delete-an-entity-webhook-endpoint"},{"openapi":"post /api/v2/entity-webhook/rotate-secret","title":"Rotate an entity webhook signing secret","href":"/v2-api-reference/entity-webhooks/rotate-an-entity-webhook-signing-secret"},{"openapi":"post /api/v2/entity-webhook/test","title":"Send a test entity webhook","href":"/v2-api-reference/entity-webhooks/send-a-test-entity-webhook"}]},{"group":"Credits","pages":[{"openapi":"get /api/v2/credits/usage","title":"Get credit usage","href":"/v2-api-reference/credits/get-credit-usage"}]},{"group":"Motion","pages":[{"openapi":"get /api/v2/motion/list","title":"List motions","href":"/v2-api-reference/motion/list-motions"},{"openapi":"get /api/v2/motion/get","title":"Get a motion","href":"/v2-api-reference/motion/get-a-motion"},{"openapi":"post /api/v2/motion/create","title":"Create a motion","href":"/v2-api-reference/motion/create-a-motion"},{"openapi":"post /api/v2/motion/update","title":"Update a motion","href":"/v2-api-reference/motion/update-a-motion"},{"openapi":"delete /api/v2/motion/delete","title":"Delete a motion","href":"/v2-api-reference/motion/delete-a-motion"}]},{"group":"Motion Playbook","pages":[{"openapi":"get /api/v2/motion-playbook/list","title":"List motion playbooks","href":"/v2-api-reference/motionplaybook/list-motion-playbooks"},{"openapi":"get /api/v2/motion-playbook/get","title":"Get a motion playbook","href":"/v2-api-reference/motionplaybook/get-a-motion-playbook"},{"openapi":"post /api/v2/motion-playbook/create","title":"Create a motion playbook","href":"/v2-api-reference/motionplaybook/create-a-motion-playbook"},{"openapi":"post /api/v2/motion-playbook/update","title":"Update a motion playbook","href":"/v2-api-reference/motionplaybook/update-a-motion-playbook"},{"openapi":"delete /api/v2/motion-playbook/delete","title":"Delete a motion playbook","href":"/v2-api-reference/motionplaybook/delete-a-motion-playbook"}]},{"group":"Motion ICP","pages":[{"openapi":"get /api/v2/motion-icp/list","title":"List Motion ICP cells","href":"/v2-api-reference/motionicp/list-motion-icp-cells"},{"openapi":"get /api/v2/motion-icp/get","title":"Get Motion ICP detail","href":"/v2-api-reference/motionicp/get-motion-icp-detail"},{"openapi":"get /api/v2/motion-icp/elements/list","title":"List recommended elements for a Motion ICP","href":"/v2-api-reference/motionicp/list-recommended-elements-for-a-motion-icp"},{"openapi":"get /api/v2/motion-icp/learnings/list","title":"List learnings for a Motion ICP","href":"/v2-api-reference/motionicp/list-learnings-for-a-motion-icp"},{"openapi":"get /api/v2/motion-icp/learnings/get","title":"Get a Motion ICP learning","href":"/v2-api-reference/motionicp/get-a-motion-icp-learning"},{"openapi":"post /api/v2/motion-icp/regenerate","title":"Regenerate a Motion ICP cell","href":"/v2-api-reference/motionicp/regenerate-a-motion-icp-cell"}]},{"group":"Product","pages":[{"openapi":"get /api/v2/product/get","title":"Get Product","href":"/v2-api-reference/product/get-product"},{"openapi":"get /api/v2/product/list","title":"List Products","href":"/v2-api-reference/product/list-products"},{"openapi":"post /api/v2/product/create","title":"Create Product","href":"/v2-api-reference/product/create-product"},{"openapi":"post /api/v2/product/update","title":"Update Product","href":"/v2-api-reference/product/update-product"},{"openapi":"post /api/v2/product/generate","title":"Generate Product","href":"/v2-api-reference/product/generate-product"},{"openapi":"delete /api/v2/product/delete","title":"Delete Product","href":"/v2-api-reference/product/delete-product"}]},{"group":"Service","pages":[{"openapi":"get /api/v2/service/list","title":"List Services","href":"/v2-api-reference/service/list-services"},{"openapi":"get /api/v2/service/get","title":"Get Service","href":"/v2-api-reference/service/get-service"},{"openapi":"post /api/v2/service/create","title":"Create Service","href":"/v2-api-reference/service/create-service"},{"openapi":"post /api/v2/service/update","title":"Update Service","href":"/v2-api-reference/service/update-service"},{"openapi":"post /api/v2/service/generate","title":"Generate Service","href":"/v2-api-reference/service/generate-service"},{"openapi":"post /api/v2/service/delete","title":"Delete Service","href":"/v2-api-reference/service/delete-service"}]},{"group":"Solution","pages":[{"openapi":"get /api/v2/solution/list","title":"List Solutions","href":"/v2-api-reference/solution/list-solutions"},{"openapi":"get /api/v2/solution/get","title":"Get Solution","href":"/v2-api-reference/solution/get-solution"},{"openapi":"post /api/v2/solution/create","title":"Create Solution","href":"/v2-api-reference/solution/create-solution"},{"openapi":"post /api/v2/solution/update","title":"Update Solution","href":"/v2-api-reference/solution/update-solution"},{"openapi":"post /api/v2/solution/generate","title":"Generate Solution","href":"/v2-api-reference/solution/generate-solution"},{"openapi":"delete /api/v2/solution/delete","title":"Delete Solution","href":"/v2-api-reference/solution/delete-solution"}]},{"group":"Segment","pages":[{"openapi":"get /api/v2/segment/get","title":"Get Segment","href":"/v2-api-reference/segment/get-segment"},{"openapi":"get /api/v2/segment/list","title":"List segments","href":"/v2-api-reference/segment/list-segments"},{"openapi":"post /api/v2/segment/update","title":"Update Segment","href":"/v2-api-reference/segment/update-segment"},{"openapi":"post /api/v2/segment/create","title":"Create Segment","href":"/v2-api-reference/segment/create-segment"},{"openapi":"post /api/v2/segment/generate","title":"Generate Segments","href":"/v2-api-reference/segment/generate-segments"},{"openapi":"delete /api/v2/segment/delete","title":"Delete Segment","href":"/v2-api-reference/segment/delete-segment"}]},{"group":"Persona","pages":[{"openapi":"get /api/v2/persona/get","title":"Get Persona","href":"/v2-api-reference/persona/get-persona"},{"openapi":"get /api/v2/persona/list","title":"List persona","href":"/v2-api-reference/persona/list-persona"},{"openapi":"post /api/v2/persona/update","title":"Update Persona","href":"/v2-api-reference/persona/update-persona"},{"openapi":"post /api/v2/persona/create","title":"Create Persona","href":"/v2-api-reference/persona/create-persona"},{"openapi":"post /api/v2/persona/generate","title":"Generate Personas","href":"/v2-api-reference/persona/generate-personas"},{"openapi":"delete /api/v2/persona/delete","title":"Delete Persona","href":"/v2-api-reference/persona/delete-persona"}]},{"group":"Use Case","pages":[{"openapi":"get /api/v2/use-case/get","title":"Get Use Case","href":"/v2-api-reference/use-case/get-use-case"},{"openapi":"get /api/v2/use-case/list","title":"List Use Cases","href":"/v2-api-reference/use-case/list-use-cases"},{"openapi":"post /api/v2/use-case/update","title":"Update Use Case","href":"/v2-api-reference/use-case/update-use-case"},{"openapi":"post /api/v2/use-case/create","title":"Create Use Case","href":"/v2-api-reference/use-case/create-use-case"},{"openapi":"post /api/v2/use-case/generate","title":"Generate Use Cases","href":"/v2-api-reference/use-case/generate-use-cases"},{"openapi":"delete /api/v2/use-case/delete","title":"Delete Use Case","href":"/v2-api-reference/use-case/delete-use-case"}]},{"group":"Reference","pages":[{"openapi":"get /api/v2/reference/get","title":"Get Reference","href":"/v2-api-reference/reference/get-reference"},{"openapi":"get /api/v2/reference/list","title":"List References","href":"/v2-api-reference/reference/list-references"},{"openapi":"post /api/v2/reference/create","title":"Create Reference","href":"/v2-api-reference/reference/create-reference"},{"openapi":"post /api/v2/reference/update","title":"Update Reference","href":"/v2-api-reference/reference/update-reference"},{"openapi":"post /api/v2/reference/generate","title":"Generate References","href":"/v2-api-reference/reference/generate-references"},{"openapi":"delete /api/v2/reference/delete","title":"Delete Reference","href":"/v2-api-reference/reference/delete-reference"}]},{"group":"Proof Point","pages":[{"openapi":"get /api/v2/proof-point/get","title":"Get Proof Point","href":"/v2-api-reference/proof-point/get-proof-point"},{"openapi":"get /api/v2/proof-point/list","title":"List proof points","href":"/v2-api-reference/proof-point/list-proof-points"},{"openapi":"post /api/v2/proof-point/update","title":"Update Proof Point","href":"/v2-api-reference/proof-point/update-proof-point"},{"openapi":"post /api/v2/proof-point/create","title":"Create Proof Point","href":"/v2-api-reference/proof-point/create-proof-point"},{"openapi":"post /api/v2/proof-point/generate","title":"Generate Proof Points","href":"/v2-api-reference/proof-point/generate-proof-points"},{"openapi":"delete /api/v2/proof-point/delete","title":"Delete Proof Point","href":"/v2-api-reference/proof-point/delete-proof-point"}]},{"group":"Competitor","pages":[{"openapi":"get /api/v2/competitor/get","title":"Get Competitor","href":"/v2-api-reference/competitor/get-competitor"},{"openapi":"get /api/v2/competitor/list","title":"List competitors","href":"/v2-api-reference/competitor/list-competitors"},{"openapi":"post /api/v2/competitor/update","title":"Update Competitor","href":"/v2-api-reference/competitor/update-competitor"},{"openapi":"post /api/v2/competitor/create","title":"Create Competitor","href":"/v2-api-reference/competitor/create-competitor"},{"openapi":"post /api/v2/competitor/generate","title":"Generate Competitors","href":"/v2-api-reference/competitor/generate-competitors"},{"openapi":"delete /api/v2/competitor/delete","title":"Delete Competitor","href":"/v2-api-reference/competitor/delete-competitor"}]},{"group":"Alternative","pages":[{"openapi":"get /api/v2/alternative/get","title":"Get Alternative","href":"/v2-api-reference/alternative/get-alternative"},{"openapi":"get /api/v2/alternative/list","title":"List alternatives","href":"/v2-api-reference/alternative/list-alternatives"},{"openapi":"post /api/v2/alternative/create","title":"Create Alternative","href":"/v2-api-reference/alternative/create-alternative"},{"openapi":"post /api/v2/alternative/update","title":"Update Alternative","href":"/v2-api-reference/alternative/update-alternative"},{"openapi":"post /api/v2/alternative/generate","title":"Generate Alternatives","href":"/v2-api-reference/alternative/generate-alternatives"},{"openapi":"delete /api/v2/alternative/delete","title":"Delete Alternative","href":"/v2-api-reference/alternative/delete-alternative"}]},{"group":"Buying Trigger","pages":[{"openapi":"get /api/v2/buying-trigger/get","title":"Get Buying Trigger","href":"/v2-api-reference/buying-trigger/get-buying-trigger"},{"openapi":"get /api/v2/buying-trigger/list","title":"List buying triggers","href":"/v2-api-reference/buying-trigger/list-buying-triggers"},{"openapi":"post /api/v2/buying-trigger/create","title":"Create Buying Trigger","href":"/v2-api-reference/buying-trigger/create-buying-trigger"},{"openapi":"post /api/v2/buying-trigger/update","title":"Update Buying Trigger","href":"/v2-api-reference/buying-trigger/update-buying-trigger"},{"openapi":"post /api/v2/buying-trigger/generate","title":"Generate Buying Triggers","href":"/v2-api-reference/buying-trigger/generate-buying-triggers"},{"openapi":"delete /api/v2/buying-trigger/delete","title":"Delete Buying Trigger","href":"/v2-api-reference/buying-trigger/delete-buying-trigger"}]},{"group":"Core Feature","pages":[{"openapi":"get /api/v2/core-feature/list","title":"List core features","href":"/v2-api-reference/core-feature/list-core-features"},{"openapi":"get /api/v2/core-feature/get","title":"Get Core Feature","href":"/v2-api-reference/core-feature/get-core-feature"},{"openapi":"post /api/v2/core-feature/create","title":"Create Core Feature","href":"/v2-api-reference/core-feature/create-core-feature"},{"openapi":"post /api/v2/core-feature/update","title":"Update Core Feature","href":"/v2-api-reference/core-feature/update-core-feature"},{"openapi":"post /api/v2/core-feature/generate","title":"Generate Core Features","href":"/v2-api-reference/core-feature/generate-core-features"},{"openapi":"delete /api/v2/core-feature/delete","title":"Delete Core Feature","href":"/v2-api-reference/core-feature/delete-core-feature"}]},{"group":"Objection","pages":[{"openapi":"get /api/v2/objection/list","title":"List objections","href":"/v2-api-reference/objection/list-objections"},{"openapi":"get /api/v2/objection/get","title":"Get Objection","href":"/v2-api-reference/objection/get-objection"},{"openapi":"post /api/v2/objection/create","title":"Create Objection","href":"/v2-api-reference/objection/create-objection"},{"openapi":"post /api/v2/objection/update","title":"Update Objection","href":"/v2-api-reference/objection/update-objection"},{"openapi":"post /api/v2/objection/generate","title":"Generate Objections","href":"/v2-api-reference/objection/generate-objections"},{"openapi":"delete /api/v2/objection/delete","title":"Delete Objection","href":"/v2-api-reference/objection/delete-objection"}]},{"group":"Brand Voice","pages":[{"openapi":"get /api/v2/brand-voice/list","title":"List Brand Voices","href":"/v2-api-reference/brand-voice/list-brand-voices"},{"openapi":"get /api/v2/brand-voice/get","title":"Get Brand Voice","href":"/v2-api-reference/brand-voice/get-brand-voice"},{"openapi":"post /api/v2/brand-voice/create","title":"Create Brand Voice","href":"/v2-api-reference/brand-voice/create-brand-voice"},{"openapi":"post /api/v2/brand-voice/update","title":"Update Brand Voice","href":"/v2-api-reference/brand-voice/update-brand-voice"},{"openapi":"post /api/v2/brand-voice/generate","title":"Generate Brand Voice","href":"/v2-api-reference/brand-voice/generate-brand-voice"},{"openapi":"post /api/v2/brand-voice/apply","title":"Apply Brand Voice","href":"/v2-api-reference/brand-voice/apply-brand-voice"},{"openapi":"post /api/v2/brand-voice/toggle-default","title":"Toggle Default Brand Voice","href":"/v2-api-reference/brand-voice/toggle-default-brand-voice"}]},{"group":"Library","pages":[{"openapi":"get /api/v2/library/download","title":"Download Library","href":"/v2-api-reference/library/download-library"},{"openapi":"get /api/v2/library/links","title":"Get Library Entity Links","href":"/v2-api-reference/library/get-library-entity-links"}]},{"group":"Library Locks","pages":[{"openapi":"post /api/v2/entity-lock/update","title":"Lock or unlock a library entity","href":"/v2-api-reference/library-locks/lock-or-unlock-a-library-entity"}]},{"group":"Context","pages":[{"openapi":"post /api/v2/context","title":"Context Search","href":"/v2-api-reference/context/context-search"}]},{"group":"Workflow","pages":[{"openapi":"post /api/v2/workflows/run","title":"Run a workflow","href":"/v2-api-reference/workflow/run-a-workflow"},{"openapi":"get /api/v2/workflows/run/status","title":"Get Workflow Run Status","href":"/v2-api-reference/workflow/get-workflow-run-status"}]},{"group":"Events","pages":[{"openapi":"get /api/v2/event/list","title":"List Events","href":"/v2-api-reference/events/list-events"},{"openapi":"post /api/v2/event/import","title":"Bulk import events","href":"/v2-api-reference/events/bulk-import-events"},{"openapi":"get /api/v2/event/import/status","title":"Get bulk import status","href":"/v2-api-reference/events/get-bulk-import-status"},{"openapi":"post /api/v2/analytics/webhook/receive/generic/{eventType}","title":"Log Event","href":"/v2-api-reference/events/log-event"},{"openapi":"post /api/v2/event/count","title":"Count Events","href":"/v2-api-reference/events/count-events"},{"openapi":"get /api/v2/event/get","title":"Get Event Detail","href":"/v2-api-reference/events/get-event-detail"},{"openapi":"post /api/v2/event/time-series","title":"Event Time Series","href":"/v2-api-reference/events/event-time-series"},{"openapi":"post /api/v2/event/cross-tab","title":"Event Cross-Tab","href":"/v2-api-reference/events/event-cross-tab"},{"openapi":"post /api/v2/event/top","title":"Top Event Entities","href":"/v2-api-reference/events/top-event-entities"},{"openapi":"post /api/v2/event/compare","title":"Compare Cohorts","href":"/v2-api-reference/events/compare-cohorts"},{"openapi":"post /api/v2/event/cohort-deals","title":"List Cohort Deals","href":"/v2-api-reference/events/list-cohort-deals"}]},{"group":"Findings","pages":[{"openapi":"get /api/v2/finding/list","title":"List Findings","href":"/v2-api-reference/findings/list-findings"},{"openapi":"post /api/v2/finding/search","title":"Search Findings","href":"/v2-api-reference/findings/search-findings"}]},{"group":"Custom Extractors","pages":[{"openapi":"get /api/v2/custom-extractor/list","title":"List Custom Extractors","href":"/v2-api-reference/custom-extractors/list-custom-extractors"},{"openapi":"post /api/v2/custom-extractor/create","title":"Create Custom Extractor","href":"/v2-api-reference/custom-extractors/create-custom-extractor"},{"openapi":"post /api/v2/custom-extractor/update","title":"Update Custom Extractor","href":"/v2-api-reference/custom-extractors/update-custom-extractor"},{"openapi":"delete /api/v2/custom-extractor/delete","title":"Delete Custom Extractor","href":"/v2-api-reference/custom-extractors/delete-custom-extractor"},{"openapi":"post /api/v2/custom-extractor/backtest","title":"Backtest Custom Extractor","href":"/v2-api-reference/custom-extractors/backtest-custom-extractor"},{"openapi":"post /api/v2/custom-extractor/backfill/estimate","title":"Estimate Custom Extractor Backfill","href":"/v2-api-reference/custom-extractors/estimate-custom-extractor-backfill"},{"openapi":"post /api/v2/custom-extractor/backfill/start","title":"Start Custom Extractor Backfill","href":"/v2-api-reference/custom-extractors/start-custom-extractor-backfill"},{"openapi":"get /api/v2/custom-extractor/backfill/get","title":"Get Custom Extractor Backfill","href":"/v2-api-reference/custom-extractors/get-custom-extractor-backfill"},{"openapi":"post /api/v2/custom-extractor/backfill/control","title":"Control Custom Extractor Backfill","href":"/v2-api-reference/custom-extractors/control-custom-extractor-backfill"},{"openapi":"post /api/v2/custom-extractor/purge-findings","title":"Purge Custom Extractor Findings","href":"/v2-api-reference/custom-extractors/purge-custom-extractor-findings"}]},{"group":"Transcript","pages":[{"openapi":"post /api/v2/transcript/search","title":"Search Call Transcripts","href":"/v2-api-reference/transcript/search-call-transcripts"},{"openapi":"post /api/v2/transcript/entity-evidence","title":"Get Entity Evidence","href":"/v2-api-reference/transcript/get-entity-evidence"}]},{"group":"Suggestions","pages":[{"openapi":"get /api/v2/suggestion/list","title":"List Suggestions","href":"/v2-api-reference/suggestions/list-suggestions"},{"openapi":"get /api/v2/suggestion/get","title":"Get Suggestion","description":"Preview a single entity suggestion in full. For 'add' suggestions, returns the complete proposed new entity. For 'refine' suggestions, returns both the current entity and what it would look like after the change, so you can show the diff. Optionally include the supporting evidence that generated it: events/findings, or the intel items behind a refine raised from competitor / segment intel.","href":"/v2-api-reference/suggestions/get-suggestion"},{"openapi":"post /api/v2/suggestion/create","title":"Create Suggestion","href":"/v2-api-reference/suggestions/create-suggestion"},{"openapi":"post /api/v2/suggestion/update","title":"Update Suggestion","description":"Edit a PENDING entity suggestion before accepting it. Two combinable modes: `instructions` regenerates the proposed content via AI; `edits` applies a precise partial field override with no regeneration. Works for both 'add' and 'refine' suggestions. Returns the updated preview. The suggestion stays pending — nothing is applied until you call suggestion/accept.","href":"/v2-api-reference/suggestions/update-suggestion"},{"openapi":"post /api/v2/suggestion/accept","title":"Accept Suggestion","href":"/v2-api-reference/suggestions/accept-suggestion"},{"openapi":"post /api/v2/suggestion/reject","title":"Reject Suggestion","href":"/v2-api-reference/suggestions/reject-suggestion"}]},{"group":"Revisions","pages":[{"openapi":"get /api/v2/revision/list","title":"List Revisions","href":"/v2-api-reference/revision/list-revisions"},{"openapi":"get /api/v2/revision/get","title":"Get Revision","href":"/v2-api-reference/revision/get-revision"}]},{"group":"Insights","pages":[{"openapi":"get /api/v2/insights/top-entities","title":"Top Entities","href":"/v2-api-reference/insights/top-entities"},{"openapi":"get /api/v2/insights/entity-stats","title":"Entity Stats","href":"/v2-api-reference/insights/entity-stats"},{"openapi":"get /api/v2/insights/entity-time-series","title":"Entity Time Series","href":"/v2-api-reference/insights/entity-time-series"},{"openapi":"get /api/v2/insights/competitive","title":"Competitive Landscape","href":"/v2-api-reference/insights/competitive-landscape"},{"openapi":"get /api/v2/insights/library-health","title":"Library Health","href":"/v2-api-reference/insights/library-health"},{"openapi":"get /api/v2/insights/workspace-baseline","title":"Workspace Baseline","href":"/v2-api-reference/insights/workspace-baseline"},{"openapi":"get /api/v2/insights/entity-usage","title":"Entity Usage","href":"/v2-api-reference/insights/entity-usage"}]},{"group":"Intel","pages":[{"openapi":"get /api/v2/intel/list","title":"List intel","href":"/v2-api-reference/intel/list-intel"},{"openapi":"get /api/v2/intel/get","title":"Get intel","href":"/v2-api-reference/intel/get-intel"}]},{"group":"Tag Group","pages":[{"openapi":"get /api/v2/tag-group/list","title":"List Tag Groups","href":"/v2-api-reference/tag-group/list-tag-groups"},{"openapi":"post /api/v2/tag-group/create","title":"Create Tag Group","href":"/v2-api-reference/tag-group/create-tag-group"},{"openapi":"post /api/v2/tag-group/update","title":"Update Tag Group","href":"/v2-api-reference/tag-group/update-tag-group"},{"openapi":"delete /api/v2/tag-group/delete","title":"Delete Tag Group","href":"/v2-api-reference/tag-group/delete-tag-group"},{"openapi":"get /api/v2/tag-group/assignments","title":"List Tag Group Assignments","href":"/v2-api-reference/tag-group/list-tag-group-assignments"},{"openapi":"get /api/v2/tag-group/performance","title":"Get Tag Group Performance","href":"/v2-api-reference/tag-group/get-tag-group-performance"},{"openapi":"post /api/v2/tag-group/backfill","title":"Backfill Tag Group","href":"/v2-api-reference/tag-group/backfill-tag-group"}]},{"group":"Tag","pages":[{"openapi":"post /api/v2/tag/create","title":"Create Tag","href":"/v2-api-reference/tag/create-tag"},{"openapi":"post /api/v2/tag/update","title":"Update Tag","href":"/v2-api-reference/tag/update-tag"},{"openapi":"delete /api/v2/tag/delete","title":"Delete Tag","href":"/v2-api-reference/tag/delete-tag"},{"openapi":"post /api/v2/tag/assign","title":"Assign Tag","href":"/v2-api-reference/tag/assign-tag"},{"openapi":"post /api/v2/tag/unassign","title":"Unassign Tag","href":"/v2-api-reference/tag/unassign-tag"}]},{"group":"Reports","pages":[{"openapi":"get /api/v2/report-group/list","title":"List report groups","href":"/v2-api-reference/reportgroup/list-report-groups"},{"openapi":"get /api/v2/report-group/get","title":"Get a report group","href":"/v2-api-reference/reportgroup/get-a-report-group"},{"openapi":"get /api/v2/report-config/list","title":"List report configs","href":"/v2-api-reference/reportconfig/list-report-configs"},{"openapi":"get /api/v2/report-config/get","title":"Get a report config","href":"/v2-api-reference/reportconfig/get-a-report-config"},{"openapi":"get /api/v2/report-run/list","title":"List report runs","href":"/v2-api-reference/reportrun/list-report-runs"},{"openapi":"get /api/v2/report-run/get","title":"Get a report run","href":"/v2-api-reference/reportrun/get-a-report-run"}]},{"group":"CRM","pages":[{"openapi":"get /api/v2/crm/get-entity-schema","title":"Get CRM Entity Schema","href":"/v2-api-reference/crm/get-crm-entity-schema"}]},{"group":"Sources","pages":[{"title":"Get Source","openapi":"get /api/v2/resource/get","href":"/v2-api-reference/resource/get-resource"},{"title":"List Sources","openapi":"get /api/v2/resource/list","href":"/v2-api-reference/resource/list-resources"},{"title":"Create Source","openapi":"post /api/v2/resource/create","href":"/v2-api-reference/resource/create-resource"},{"title":"Delete Source(s)","openapi":"post /api/v2/resource/delete","href":"/v2-api-reference/resource/delete-resources"},{"title":"Get Source Status","openapi":"get /api/v2/resource/status","href":"/v2-api-reference/resource/get-resource-status"},{"title":"Search Sources","openapi":"post /api/v2/resource/search","href":"/v2-api-reference/resource/search-resources"},{"title":"Check Source Drift","openapi":"post /api/v2/resource/check-drift","href":"/v2-api-reference/resource/check-resource-drift"},{"title":"Link Entities to Source","openapi":"post /api/v2/resource/link-entities","href":"/v2-api-reference/resource/link-entities-to-resource"}]},{"group":"Skill","pages":[{"openapi":"get /api/v2/skill/list","title":"List Skills","href":"/v2-api-reference/skill/list-skills"},{"openapi":"get /api/v2/skill/get","title":"Get Skill","href":"/v2-api-reference/skill/get-skill"},{"openapi":"get /api/v2/skill/file","title":"Get Skill File","href":"/v2-api-reference/skill/get-skill-file"},{"openapi":"post /api/v2/skill/create","title":"Create Skill","href":"/v2-api-reference/skill/create-skill"},{"openapi":"post /api/v2/skill/update","title":"Update Skill","href":"/v2-api-reference/skill/update-skill"},{"openapi":"post /api/v2/skill/delete","title":"Delete Skill","href":"/v2-api-reference/skill/delete-skill"},{"openapi":"post /api/v2/skill/find","title":"Find Skill","href":"/v2-api-reference/skill/find-skill"}]},{"group":"Asset","pages":[{"title":"Publishing Assets via API","href":"/v2-api-reference/asset/publishing-assets"},{"openapi":"get /api/v2/asset/list","title":"List Assets","href":"/v2-api-reference/asset/list-assets"},{"openapi":"get /api/v2/asset/get","title":"Get Asset","href":"/v2-api-reference/asset/get-asset"},{"openapi":"post /api/v2/asset/update","title":"Update Asset","href":"/v2-api-reference/asset/update-asset"},{"openapi":"delete /api/v2/asset/delete","title":"Delete Asset","href":"/v2-api-reference/asset/delete-asset"},{"openapi":"get /api/v2/asset/stats","title":"Get Asset Stats","href":"/v2-api-reference/asset/get-asset-stats"},{"openapi":"get /api/v2/asset/visitors","title":"List Asset Visitors","href":"/v2-api-reference/asset/list-asset-visitors"},{"openapi":"get /api/v2/asset/versions/list","title":"List Asset Versions","href":"/v2-api-reference/asset/list-asset-versions"},{"openapi":"post /api/v2/asset/versions/restore","title":"Restore Asset Version","href":"/v2-api-reference/asset/restore-asset-version"},{"openapi":"delete /api/v2/asset/versions/delete","title":"Delete Asset Version","href":"/v2-api-reference/asset/delete-asset-version"},{"openapi":"get /api/v2/asset/shares/list","title":"List Asset Shares","href":"/v2-api-reference/asset/list-asset-shares"},{"openapi":"post /api/v2/asset/shares/create","title":"Create Asset Share","href":"/v2-api-reference/asset/create-asset-share"},{"openapi":"delete /api/v2/asset/shares/revoke","title":"Revoke Asset Share","href":"/v2-api-reference/asset/revoke-asset-share"},{"openapi":"post /api/v2/asset/shares/add-recipients","title":"Add Asset Share Recipients","href":"/v2-api-reference/asset/add-asset-share-recipients"},{"openapi":"post /api/v2/asset/shares/remove-recipients","title":"Remove Asset Share Recipients","href":"/v2-api-reference/asset/remove-asset-share-recipients"},{"openapi":"post /api/v2/asset/shares/add-domains","title":"Add Asset Share Domains","href":"/v2-api-reference/asset/add-asset-share-domains"},{"openapi":"post /api/v2/asset/shares/remove-domains","title":"Remove Asset Share Domains","href":"/v2-api-reference/asset/remove-asset-share-domains"},{"openapi":"get /api/v2/asset/access-requests/list","title":"List Asset Access Requests","href":"/v2-api-reference/asset/list-asset-access-requests"},{"openapi":"post /api/v2/asset/access-requests/grant","title":"Grant Asset Access Request","href":"/v2-api-reference/asset/grant-asset-access-request"},{"openapi":"post /api/v2/asset/access-requests/dismiss","title":"Dismiss Asset Access Request","href":"/v2-api-reference/asset/dismiss-asset-access-request"},{"openapi":"post /api/v2/asset/access-token/generate","title":"Generate Asset Access Token","href":"/v2-api-reference/asset/generate-asset-access-token"},{"openapi":"post /api/v2/asset/access-token/refresh","title":"Refresh Asset Access Token","href":"/v2-api-reference/asset/refresh-asset-access-token"},{"openapi":"post /api/v2/asset/transfer","title":"Transfer Asset","href":"/v2-api-reference/asset/transfer-asset"}]},{"group":"Workspace Company","pages":[{"openapi":"get /api/v2/workspace-company/get","title":"Get Workspace Company","href":"/v2-api-reference/workspace-company/get-workspace-company"},{"openapi":"post /api/v2/workspace-company/update","title":"Update Workspace Company","href":"/v2-api-reference/workspace-company/update-workspace-company"},{"openapi":"post /api/v2/workspace-company/generate","title":"Generate Workspace Company","href":"/v2-api-reference/workspace-company/generate-workspace-company"}]},{"group":"Legacy Playbooks","pages":[{"title":"Legacy Playbooks (deprecated)","href":"/concepts/playbooks"},{"openapi":"get /api/v2/playbook/list","title":"List Playbooks","href":"/v2-api-reference/playbook/list-playbooks"},{"openapi":"get /api/v2/playbook/get","title":"Get Playbook","href":"/v2-api-reference/playbook/get-playbook"},{"openapi":"post /api/v2/playbook/create","title":"Create Playbook","href":"/v2-api-reference/playbook/create-playbook"},{"openapi":"post /api/v2/playbook/update","title":"Update Playbook","href":"/v2-api-reference/playbook/update-playbook"},{"openapi":"delete /api/v2/playbook/delete","title":"Delete Playbook","href":"/v2-api-reference/playbook/delete-playbook"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"title":"Create Suggestion - Octave API","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}