> ## Documentation Index > Fetch the complete documentation index at: https://docs.preuve.ai/llms.txt > Use this file to discover all available pages before exploring further. # Discover the API > 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. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/agent openapi: 3.1.0 info: title: Preuve Agent API version: '2.0' summary: Startup idea validation for AI agents and scripts. description: > API for programmatic startup idea validation: a 0-100 viability score, competitors, market sizing and source-linked evidence from 60+ live sources. Every request carries a single x-preuve-key header holding the whole API key - no signing, no bearer token. See the Authentication guide. Every response is JSON, errors included: an unknown route answers 404 with the same { error, code } envelope as every other failure, so branch on code and never parse a message. Error codes are stable and retired ones stay listed on the Errors page. scanType "starter" costs nothing and returns a real report, which makes it the sandbox: an agent can exercise the whole create - poll - enrich - export loop without spending a cent. GET /api/agent is the unauthenticated discovery document. termsOfService: https://preuve.ai/terms contact: name: Preuve AI developer support url: https://preuve.ai/support email: hello@preuve.ai servers: - url: https://preuve.ai security: - preuveKey: [] tags: - name: Discovery description: Unauthenticated documents that describe the API itself. - name: Analyses description: One idea at a time - create, poll, enrich, export. - name: Batches description: Up to five analyses in one idempotent batch. - name: Tools description: Utilities that spend no scan quota. - name: Agency description: >- Client work on a Consultant or Agency workspace (agency:read / agency:write). externalDocs: description: Developer docs - quickstart, authentication, quotas, error codes url: https://docs.preuve.ai/ paths: /api/agent: get: tags: - Discovery 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. operationId: getApiDiscovery responses: '200': description: The discovery document. content: application/json: schema: $ref: '#/components/schemas/ApiDiscovery' '500': $ref: '#/components/responses/InternalError' security: [] components: schemas: ApiDiscovery: type: object description: The unauthenticated GET /api/agent document. required: - name - version - baseUrl - openapi - authentication - endpoints properties: name: type: string description: type: string version: type: string baseUrl: type: string format: uri openapi: type: object properties: json: type: string format: uri yaml: type: string format: uri apiCatalog: type: string format: uri description: RFC 9727 api-catalog Linkset. docs: type: object additionalProperties: type: string format: uri authentication: type: object properties: type: type: string enum: - apiKey header: type: string keyPrefix: type: string selfServe: type: string format: uri oauth: type: string format: uri note: type: string pricing: type: object additionalProperties: type: string rateLimits: type: object additionalProperties: type: string errors: type: object additionalProperties: true endpoints: type: array items: type: object required: - method - path - operationId properties: method: type: string path: type: string operationId: type: string mcp: type: object additionalProperties: type: string ApiError: 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. properties: error: type: string description: Human-readable message. Prose; it changes. code: type: string description: Stable machine-readable code. Branch on this. details: 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. oneOf: - type: object additionalProperties: true - type: array items: type: 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. remaining: type: integer description: Requests left in the current window. resetAt: type: string format: date-time description: > When the window that refused this request reopens. Present on DAILY_LIMIT_REACHED; prefer it over the Retry-After header when both are present, since it is absolute. tokenBalance: type: integer description: >- Deep-scan credits left on the account. Present on INSUFFICIENT_TOKENS. scansUsed: type: integer scansRemaining: type: integer limitType: type: string description: Which ceiling refused an AppSumo-backed account. upgradeHint: type: string description: What to change to get past this refusal. Prose, not a contract. paused: type: boolean description: > Present only on the LLM-pause 503, where the body is exactly { error, code, paused }. upsell: $ref: '#/components/schemas/ExportUpsell' ExportUpsell: 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. properties: offer: type: string enum: - founder_report - scan_pack description: > "founder_report" is the $29 one-time tier. "scan_pack" is a top-up for an account that already bought and has no deep credits left. price: type: string description: Display price text, e.g. "$29 one-time". guarantee: type: string description: > Guarantee text for offer=founder_report. Omitted for scan_pack top-ups; an empty string is never used. url: type: string format: uri description: Purchase or report URL, with attribution query parameters. locked: type: array description: > Section names the offer covers. Distinct from the top-level locked object, which names response FIELDS. items: type: string note: type: string description: The same facts as one sentence, for a client that relays text. responses: InternalError: 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. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: preuveKey: type: apiKey in: header name: x-preuve-key description: > Your API key (prv_...), sent as-is. It is the only credential the API needs - see the Authentication guide. ````