Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.
GET
/
api
/
agent
Discover the API
curl --request GET \
--url https://preuve.ai/api/agent
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Preuve AI Developers","description":"Validate startup ideas from Claude, Cursor, or Codex. Viability score, competitors, source-linked evidence.","colors":{"primary":"#ea580c","light":"#f97316","dark":"#ea580c"},"logo":{"light":"https://mintcdn.com/preuve-ai/jZodzg3khCalFU2b/logo/dark.svg?fit=max\u0026auto=format\u0026n=jZodzg3khCalFU2b\u0026q=85\u0026s=e5e818b7a52b31b8d49949427aa2921e","dark":"https://mintcdn.com/preuve-ai/jZodzg3khCalFU2b/logo/light.svg?fit=max\u0026auto=format\u0026n=jZodzg3khCalFU2b\u0026q=85\u0026s=d9c1ae471ba09c9b047d4421f0296d4c","href":"https://preuve.ai"},"favicon":"https://mintcdn.com/preuve-ai/jZodzg3khCalFU2b/favicon.svg?fit=max\u0026auto=format\u0026n=jZodzg3khCalFU2b\u0026q=85\u0026s=bcff624580bc3ba18ad4ae414e22a998","appearance":{"default":"light"},"background":{"color":{"light":"#ffffff","dark":"#09090b"}},"navbar":{"links":[{"href":"https://preuve.ai","label":"preuve.ai"}],"primary":{"type":"button","label":"Get API key","href":"https://preuve.ai/app?settings=apiKeys"}},"footer":{"socials":{"x":"https://x.com/VincentBuilds","website":"https://preuve.ai"}},"seo":{"metatags":{"og:site_name":"Preuve AI Developers"}},"integrations":{"posthog":{"apiKey":"phc_n0wxSs3oUf8AS0VLFb0YpqyX7oLbTtwEYHg0oH35aOE","sessionRecording":false}},"contextual":{"options":["copy","chatgpt","claude","perplexity",{"title":"Validate an idea","description":"Run a free starter scan on preuve.ai","icon":"play","href":"https://preuve.ai/app"}],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"preuve-ai","hasAudioNarration":false,"actualSubdomain":"preuve-ai","customDomains":["docs.preuve.ai"],"gitSource":{"type":"github","owner":"vxncxnx","repo":"startup-viability-analyzer","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"82f72e53-511c-407c-8e81-8ba4eab344f4","liveDeploymentHistoryId":"6ada1ce5f7b413b0bdc35e9c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada1ce5f7b413b0bdc35e9c"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6addc0c5018724cf907f6fab","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Endpoints","count":14},{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"Agency","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Analyses","count":4},{"language":"default","tag":"Batches","count":3},{"language":"default","tag":"For agents","count":2},{"language":"default","tag":"Discovery","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"api-reference/discovery/discover-the-api","slug":"/api-reference/discovery/discover-the-api","pageMetadata":{"title":"Discover the API","description":"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent","href":"/api-reference/discovery/discover-the-api","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the 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":"Discover the API","description":"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent","href":"/api-reference/discovery/discover-the-api","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getApiDiscovery","summary":"Discover the API","description":"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\n","tags":["Discovery"],"security":[],"responses":{"200":"3866a3ea-95d7-43fd-af97-468de4080373","500":"03056faa-3ee8-4a7f-b7c3-f835bc0d329f"},"method":"get","type":"path","servers":["715cf00a-3ffc-4b59-ae77-e743b8872f58"],"path":"/api/agent","baseUrlOptions":["https://preuve.ai"],"title":"Discover the API","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"3866a3ea-95d7-43fd-af97-468de4080373":{"description":"The discovery document.","content":{"application/json":{"schema":{"type":"object","description":"The unauthenticated GET /api/agent document.","required":["name","version","baseUrl","openapi","authentication","endpoints"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"version":{"type":"string","isRequired":true,"uniqueKey":"version","typeLabel":"string"},"baseUrl":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"baseUrl","typeLabel":"string\u003curi>"},"openapi":{"type":"object","properties":{"json":{"type":"string","format":"uri","uniqueKey":"openapi.json","typeLabel":"string\u003curi>"},"yaml":{"type":"string","format":"uri","uniqueKey":"openapi.yaml","typeLabel":"string\u003curi>"},"json30":{"type":"string","format":"uri","description":"The same spec as OpenAPI 3.0.3, for importers that reject 3.1.","uniqueKey":"openapi.json30","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"openapi","typeLabel":"object"},"authentication":{"type":"object","properties":{"type":{"type":"string","enum":["apiKey"],"uniqueKey":"authentication.type","typeLabel":"enum\u003cstring>"},"header":{"type":"string","uniqueKey":"authentication.header","typeLabel":"string"},"keyPrefix":{"type":"string","uniqueKey":"authentication.keyPrefix","typeLabel":"string"},"selfServe":{"type":"string","format":"uri","uniqueKey":"authentication.selfServe","typeLabel":"string\u003curi>"},"oauth":{"type":"string","format":"uri","uniqueKey":"authentication.oauth","typeLabel":"string\u003curi>"},"note":{"type":"string","uniqueKey":"authentication.note","typeLabel":"string"}},"isRequired":true,"uniqueKey":"authentication","typeLabel":"object"},"endpoints":{"type":"array","items":{"type":"object","required":["method","path","operationId"],"properties":{"method":{"type":"string","isRequired":true,"uniqueKey":"endpoints.items.[INDEX].method","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"endpoints.items.[INDEX].path","typeLabel":"string"},"operationId":{"type":"string","isRequired":true,"uniqueKey":"endpoints.items.[INDEX].operationId","typeLabel":"string"}},"uniqueKey":"endpoints.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"endpoints","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"apiCatalog":{"type":"string","format":"uri","description":"RFC 9727 api-catalog Linkset.","uniqueKey":"apiCatalog","typeLabel":"string\u003curi>"},"docs":{"type":"object","additionalProperties":{"type":"string","format":"uri","uniqueKey":"docs.additionalProperties","typeLabel":"string\u003curi>"},"uniqueKey":"docs","typeLabel":"object"},"pricing":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"pricing.additionalProperties","typeLabel":"string"},"uniqueKey":"pricing","typeLabel":"object"},"rateLimits":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateLimits.additionalProperties","typeLabel":"string"},"uniqueKey":"rateLimits","typeLabel":"object"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"},"mcp":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"mcp.additionalProperties","typeLabel":"string"},"uniqueKey":"mcp","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","version":"\u003cstring>","baseUrl":"\u003cstring>","openapi":{"json":"\u003cstring>","yaml":"\u003cstring>","json30":"\u003cstring>"},"authentication":{"type":"apiKey","header":"\u003cstring>","keyPrefix":"\u003cstring>","selfServe":"\u003cstring>","oauth":"\u003cstring>","note":"\u003cstring>"},"endpoints":[{"method":"\u003cstring>","path":"\u003cstring>","operationId":"\u003cstring>"}],"description":"\u003cstring>","apiCatalog":"\u003cstring>","docs":{},"pricing":{},"rateLimits":{},"errors":{},"mcp":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"03056faa-3ee8-4a7f-b7c3-f835bc0d329f":{"description":"Unexpected server error (INTERNAL_ERROR, or TRIGGER_DISPATCH_FAILED when a deep scan could not be handed to the job runner). Never tell the user their quota is safe: on a deep scan the spend can already have happened when the failure hit, and an ambiguous dispatch deliberately keeps the report and its funding because the job may have been accepted before its response was lost. Treat consumption as unknown and retry with backoff. On an operation that takes a clientRunId, retry with the SAME one - that reconciles the original run, whatever state it reached, instead of starting and charging for a second one. On every other operation there is nothing to reconcile: the read or export simply failed, so a plain backed-off retry is the whole recovery.\n","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"Every error, on every route, unknown paths included. Some codes add top-level context fields (limit, tokenBalance, resetAt, upsell, ...); a 404 NOT_FOUND on an unknown route adds details.discovery, details.openapi and details.docs so the caller can recover.\n","properties":{"error":{"type":"string","description":"Human-readable message. Prose; it changes.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable code. Branch on this.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional context. An object on most codes (limits, recovery links, the method and path of a 404); an array of strings where the route forwards a validator's messages, as enrich does on INVALID_FOUNDER_PROFILE. Read it, never branch on it - `code` is the contract.\n","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"string","uniqueKey":"details.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Optional context. An object on most codes (limits, recovery links, the method and path of a 404); an array of strings where the route forwards a validator's messages, as enrich does on INVALID_FOUNDER_PROFILE. Read it, never branch on it - `code` is the contract.\n","uniqueKey":"details.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"details","typeLabel":"object | string[]"},"limit":{"type":"integer","description":"The ceiling that was hit, in the unit the code implies: bytes on PAYLOAD_TOO_LARGE, runs in flight on CONCURRENT_LIMIT_REACHED, requests in the window on a rate limit.\n","uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests left in the current window.","uniqueKey":"remaining","typeLabel":"integer"},"resetAt":{"type":"string","format":"date-time","description":"When the window that refused this request reopens. Present on DAILY_LIMIT_REACHED from run creation (the idea generator's rolling ceiling sends only limit); prefer it over the Retry-After header when both are present, since it is absolute.\n","uniqueKey":"resetAt","typeLabel":"string\u003cdate-time>"},"tokenBalance":{"type":"integer","description":"Deep-scan credits left on the account. Present on INSUFFICIENT_TOKENS.","uniqueKey":"tokenBalance","typeLabel":"integer"},"scansUsed":{"type":"integer","uniqueKey":"scansUsed","typeLabel":"integer"},"scansRemaining":{"type":"integer","uniqueKey":"scansRemaining","typeLabel":"integer"},"limitType":{"type":"string","description":"Which ceiling refused an AppSumo-backed account.","uniqueKey":"limitType","typeLabel":"string"},"upgradeHint":{"type":"string","description":"What to change to get past this refusal. Prose, not a contract.","uniqueKey":"upgradeHint","typeLabel":"string"},"creditScans":{"type":"object","description":"Present on STARTER_LIMIT_REACHED for an account whose starter scans are a fixed bank: its 10-scan credits pack is empty, what a pack costs in credits, the credit balance, and whether the account can buy credits.\n","properties":{"available":{"type":"integer","uniqueKey":"creditScans.available","typeLabel":"integer"},"packCost":{"type":"integer","uniqueKey":"creditScans.packCost","typeLabel":"integer"},"packSize":{"type":"integer","uniqueKey":"creditScans.packSize","typeLabel":"integer"},"balance":{"type":"integer","uniqueKey":"creditScans.balance","typeLabel":"integer"},"canBuyBundles":{"type":"boolean","uniqueKey":"creditScans.canBuyBundles","typeLabel":"boolean"}},"uniqueKey":"creditScans","typeLabel":"object"},"paused":{"type":"boolean","description":"Present only on the LLM-pause 503, where the body is exactly { error, code, paused }.\n","uniqueKey":"paused","typeLabel":"boolean"},"upsell":{"type":"object","description":"Purchase context for a locked export or buyable quota refusal. Export upsells are free-owner only; a paid non-regional caller may receive a scan_pack top-up on INSUFFICIENT_TOKENS. Ignore it if you only need the data contract.\n","properties":{"offer":{"type":"string","enum":["founder_report","scan_pack"],"description":"\"founder_report\" is the $59 one-time tier. \"scan_pack\" is a top-up for an account that already bought and has no deep credits left.\n","uniqueKey":"upsell.offer","typeLabel":"enum\u003cstring>"},"price":{"type":"string","description":"Display price text, e.g. \"$59 one-time\".","uniqueKey":"upsell.price","typeLabel":"string"},"guarantee":{"type":"string","description":"Guarantee text for offer=founder_report. Omitted for scan_pack top-ups; an empty string is never used.\n","uniqueKey":"upsell.guarantee","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"Purchase or report URL, with attribution query parameters.","uniqueKey":"upsell.url","typeLabel":"string\u003curi>"},"locked":{"type":"array","description":"Section names the offer covers. Distinct from the top-level locked object, which names response FIELDS.\n","items":{"type":"string","uniqueKey":"upsell.locked.items.[INDEX]","typeLabel":"string"},"uniqueKey":"upsell.locked","typeLabel":"string[]"},"note":{"type":"string","description":"The same facts as one sentence, for a client that relays text.","uniqueKey":"upsell.note","typeLabel":"string"}},"uniqueKey":"upsell","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{},"limit":123,"remaining":123,"resetAt":"2023-11-07T05:31:56Z","tokenBalance":123,"scansUsed":123,"scansRemaining":123,"limitType":"\u003cstring>","upgradeHint":"\u003cstring>","creditScans":{"available":123,"packCost":123,"packSize":123,"balance":123,"canBuyBundles":true},"paused":true,"upsell":{"offer":"founder_report","price":"\u003cstring>","guarantee":"\u003cstring>","url":"\u003cstring>","locked":["\u003cstring>"],"note":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"715cf00a-3ffc-4b59-ae77-e743b8872f58":{"url":"https://preuve.ai"}}},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"preuve-ai","siteName":"Preuve AI Developers","title":"Discover the API - Preuve AI Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T08:41:45.452Z","originalFileLocation":"api-reference/discovery/discover-the-api.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Preuve AI Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_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/preuve-ai/tKC7ZmhWCLDiptRy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Discover the API - Preuve AI Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Preuve AI Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.preuve.ai/api-reference/discovery/discover-the-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://preuve-ai.mintlify.app/_mintlify/api/og/v2?division=Discovery\u0026amp;title=Discover+the+API\u0026amp;description=Unauthenticated+discovery+document%3A+base+URL%2C+where+the+OpenAPI+spec+and+the+docs+live%2C+how+authentication+works%2C+what+a+call+costs%2C+the+rate+limits+and+the+ful\u0026amp;theme=6464a725cf96986812cd17a5\u0026amp;signature=82dc671d8eff9e7d504d6fe6fbd0c40a407b95876f923d654a4659771d1a5826\">\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=\"Discover the API - Preuve AI Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://preuve-ai.mintlify.app/_mintlify/api/og/v2?division=Discovery\u0026amp;title=Discover+the+API\u0026amp;description=Unauthenticated+discovery+document%3A+base+URL%2C+where+the+OpenAPI+spec+and+the+docs+live%2C+how+authentication+works%2C+what+a+call+costs%2C+the+rate+limits+and+the+ful\u0026amp;theme=6464a725cf96986812cd17a5\u0026amp;signature=82dc671d8eff9e7d504d6fe6fbd0c40a407b95876f923d654a4659771d1a5826\">\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/preuve-ai/tKC7ZmhWCLDiptRy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Preuve AI Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ea580c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.preuve.ai/api-reference/discovery/discover-the-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/discovery/discover-the-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.preuve.ai/#organization\",\"name\":\"Preuve AI Developers\",\"url\":\"https://docs.preuve.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/preuve-ai/jZodzg3khCalFU2b/logo/dark.svg?fit=max\u0026auto=format\u0026n=jZodzg3khCalFU2b\u0026q=85\u0026s=e5e818b7a52b31b8d49949427aa2921e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.preuve.ai#website\",\"name\":\"Preuve AI Developers\",\"url\":\"https://docs.preuve.ai\",\"publisher\":{\"@id\":\"https://docs.preuve.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api#webpage\",\"url\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api\",\"name\":\"Discover the API\",\"description\":\"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\",\"dateModified\":\"2026-10-25T08:41:45.452Z\",\"isPartOf\":{\"@id\":\"https://docs.preuve.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Preuve AI Developers\",\"item\":\"https://docs.preuve.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Discover the API\",\"item\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api#apireference\",\"headline\":\"Discover the API\",\"name\":\"Discover the API\",\"description\":\"Unauthenticated discovery document: base URL, where the OpenAPI spec and the docs live, how authentication works, what a call costs, the rate limits and the full endpoint list. Read this first when you know nothing else about the API.\",\"url\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.preuve.ai/api-reference/discovery/discover-the-api#webpage\"},\"dateModified\":\"2026-10-25T08:41:45.452Z\",\"publisher\":{\"@id\":\"https://docs.preuve.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.preuve.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Preuve AI Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Preuve AI Developers","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Reference","icon":"book-open","pages":[{"title":"Introduction","description":"Thirteen endpoints: create, poll, enrich, export, idea generation, and Agency client work.","icon":"book-open","iconType":"solid","href":"/api-reference/introduction"}]},{"group":"Endpoints","icon":"code","pages":[{"group":"Discovery","pages":[{"title":"Discover the API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent","href":"/api-reference/discovery/discover-the-api"}]},{"group":"Analyses","pages":[{"title":"Start an analysis","description":"Create one analysis run. Async - poll with GET /api/agent/analyses/{id}. scanType is required and explicit: \"starter\" costs nothing, \"deep\" consumes paid account quota. clientRunId is your idempotency key: re-POSTing the same value replays the existing run.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/agent/analyses","href":"/api-reference/analyses/start-an-analysis"},{"title":"Poll an analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/analyses/{id}","href":"/api-reference/analyses/poll-an-analysis"},{"title":"Enrich an analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/agent/analyses/{id}/enrich","href":"/api-reference/analyses/enrich-an-analysis"},{"title":"Export an analysis (ideas-json)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/analyses/{id}/export","href":"/api-reference/analyses/export-an-analysis-ideas-json"}]},{"group":"Batches","pages":[{"title":"Start a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/agent/analysis-batches","href":"/api-reference/batches/start-a-batch"},{"title":"Poll a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/analysis-batches/{batchId}","href":"/api-reference/batches/poll-a-batch"},{"title":"Export a batch (ideas-json)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/analysis-batches/{batchId}/export","href":"/api-reference/batches/export-a-batch-ideas-json"}]},{"group":"Tools","pages":[{"title":"Generate startup ideas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/agent/tools/idea-generator","href":"/api-reference/tools/generate-startup-ideas"}]},{"group":"Agency","pages":[{"title":"Get the Agency workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/agency","href":"/api-reference/agency/get-the-agency-workspace"},{"title":"Start a client project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /api/agent/agency/analyses","href":"/api-reference/agency/start-a-client-project"},{"title":"List client reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/agency/reports","href":"/api-reference/agency/list-client-reports"},{"title":"Poll a client report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/agency/reports/{id}","href":"/api-reference/agency/poll-a-client-report"},{"title":"Export a client report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /api/agent/agency/reports/{id}/export","href":"/api-reference/agency/export-a-client-report"}]}]}]}]},"title":"Discover the API - Preuve AI Developers","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}