--- title: "Poll a batch" method: GET path: "/api/agent/analysis-batches/{batchId}" tags: ["Batches"] --- # Poll a batch `GET /api/agent/analysis-batches/{batchId}` ## Request - Base URL: `https://preuve.ai` - URL: `https://preuve.ai/api/agent/analysis-batches/{batchId}` - Auth: API key in header `x-preuve-key` Batch state with one AnalysisRun per item. Item statuses are reconciled on every read, so a creation-time FAILED that was really a lost dispatch response heals here. ## Path parameters - `batchId` string, uuid, required ## Response `200` Batch state with per-item statuses. - Batch - `id` string, uuid - `clientRunId` string - `name` string, nullable - `status` string - `counts` object - `items` BatchItem[] - union: One entry in a batch. Either a real run or a late-collision stub; the two are told apart by id, which is null only on the stub. - AnalysisRun - `id` string, uuid - `reportId` string, uuid, nullable: Null until the report row is attached, which is why a run that failed before dispatch is retryable under the same clientRunId. - `clientRunId` string, nullable: The caller-chosen id from create. Null when the analysis is a dashboard-created report resolved by its report id: no run row exists, so there is no clientRunId to replay. - `batchId` string, uuid, nullable: The batch this run belongs to, or null for a standalone run. - `scanType` 'starter' | 'deep': Your request type. Reliable from creation, even while PROCESSING. - `enrichmentMode` 'core' | 'none' - `publish` boolean - `reportType` 'quick' | 'deep_dive' | 'null', nullable - `analysisTier` 'basic' | 'advanced' | 'null', nullable: Derived from the report. Deep runs read "basic" until deep sections land. - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' - `progressStep` string, nullable: Free-text pipeline stage while PROCESSING. - `errorCode` string, nullable: Set on a FAILED run. Two internal markers are deliberately rewritten before they leave: an ambiguous dispatch reports TRIGGER_DISPATCH_FAILED and an ambiguous claim refund reports REPORT_CREATE_FAILED. - `errorMessage` string, nullable - `resetAt` string, date-time: Present only on a batch item refused by the rolling daily cap; absent, not null, on every other run. - `pollAfterSeconds` integer: Present only while polling is still useful. Pace by this rather than by a fixed interval. - `pollHint` string: Present alongside pollAfterSeconds. - `createdAt` string, date-time - `updatedAt` string, date-time - `readyForExport` boolean: Whether GET /export will serve this analysis now. Always false for a report created on the preuve.ai dashboard, whatever state the report is in, because that export answers 403 REPORT_NOT_FROM_AGENT_RUN. Branch on exportable first. - `exportable` boolean: Present, and false, only on a report created on the preuve.ai dashboard. Absent means the ordinary contract applies and readyForExport is the gate. When it is false, no amount of polling or enriching changes it. - `exportBlockedCode` 'REPORT_NOT_FROM_AGENT_RUN': Present alongside exportable, naming the refusal. - `exportBlockedHint` string: Present alongside exportable. Relayable prose. - `enrichment` EnrichmentState: Progress of the core export sections. The four name arrays partition `required`, so a poller decides what to do next by reading them rather than by parsing `status`: anything in processing means keep polling, anything in failed means call enrich again, and missing with nothing processing means enrichment was never started for it. - `mode` 'core' | 'none' - `status` 'not_required' | 'pending' | 'processing' | 'partial' | 'completed' | 'failed': Rolled up from the arrays below. "partial" means some sections landed and others did not; "not_required" is mode "none", or a report with no required sections. - `required` string[]: Every section this report and mode need. The other four arrays partition it. - `completed` string[] - `missing` string[]: Required, not generated, and not currently being generated. - `processing` string[]: Generation is in flight. Keep polling rather than calling enrich again. - `failed` string[]: Generation was attempted and failed. Retryable by calling enrich again. - `sections` object: Per-section detail, keyed by section name, for every entry in required. Each value carries at least a status matching the array the section is in, plus completedAt on a completed section and whatever the last attempt recorded on a failed one. - `modules` object, nullable: Per-module statuses. Deep reports only; null on free runs. - `proofOfDemand` ModuleStatus - `status` 'not_generated' | 'generating' | 'failed' | 'completed' - `founderFit` ModuleStatus - `status` 'not_generated' | 'generating' | 'failed' | 'completed' - `playbook` ModuleStatus - `status` 'not_generated' | 'generating' | 'failed' | 'completed' - `trends` ModuleStatus - `status` 'not_generated' | 'generating' | 'failed' | 'completed' - `community` ModuleStatus - `status` 'not_generated' | 'generating' | 'failed' | 'completed' - `reportUrl` string, uri, nullable: Null until the report row exists. - `shareUrl` string, uri, nullable - BatchItemConflict: Not a run. Another request claimed this item's clientRunId after the batch row was reserved but before the item started, so nothing was created and id is null. Appears in Batch.items on create, on replay and on poll, and its null id carries through to BatchExport.omittedItems. - `id` unknown - `reportId` unknown - `clientRunId` string - `batchId` string, uuid - `status` 'FAILED' - `errorCode` 'CLIENT_RUN_ID_CONFLICT' - `errorMessage` string ## Other responses - `400`: The request was rejected before any work started: malformed JSON (INVALID_JSON), an id that is not one of ours (INVALID_ANALYSIS_ID, INVALID_BATCH_ID), an export format we do not serve (UNSUPPORTED_FORMAT), or a field the schema cannot express - an idea too short to analyse, a batch outside 1..5 items (INVALID_BATCH_SIZE), two batch items sharing a clientRunId (DUPLICATE_CLIENT_RUN_ID), an unknown scanType. No paid quota, tokens, or scans were consumed. On the CREATE routes a rate-limit window can still be: those per-account limiters are claimed ahead of schema validation on purpose, so that malformed spam is metered, and retrying unchanged spends another slot. Enrich no longer works that way - since 2026-09-15 its 12/min window is claimed after the body is validated, so a malformed enrich costs nothing. Fix the request either way; retrying it unchanged returns the same answer. - `401`: Missing x-preuve-key header (MISSING_API_KEY), or a malformed, unknown or revoked key (INVALID_AGENT_KEY - the same envelope for all three, on purpose). Repeated failures are throttled per IP and answer 429. - `403`: The key is valid but was not granted the scope this route requires (INSUFFICIENT_SCOPE). Scopes are per route and fixed when the key is created: analysis:write to start a run, analysis:read to poll it, export:read to export, batch:write and batch:read for batches. They are never widened afterwards, so this is not retryable - the user reconnects the client and approves the missing permission, or creates a new key with it. Distinct from 401, which means the key itself was not accepted. - `404`: Unknown id, or the resource belongs to another account. The code names what was looked up: ANALYSIS_NOT_FOUND on the analysis routes, BATCH_NOT_FOUND on the batch ones. The analysis routes also answer REPORT_DELETED when the run exists but its report was deleted from the dashboard: nothing is left to poll, enrich or export. - `500`: 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. - `503`: A dependency was unavailable or deliberately paused (SERVICE_DISABLED, LLM_PAUSED, PROFILE_LOOKUP_FAILED, and the fail-closed answer when the rate-limit backend is down). Any authenticated route can answer this one: authentication meters itself through the same fail-closed limiter, so an outage there refuses the request before the handler runs. Retryable, and no paid quota, tokens, or scans were consumed - a pause that lands mid-run refunds the claim it had already made. Back off and try again rather than falling back to a different endpoint. --- [API](https://skmtc.dev/preuve/apis/preuve-agent-api.md) · [All operations](https://skmtc.dev/preuve/apis/preuve-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/preuve/apis/preuve-agent-api/revisions/d58b3d396fa7?raw)