AI Intelligence

Recover a document extraction request

Read the original durable request under its exact current actor, workspace and key authority. Requires ai:extract for API keys. No body, original text, provider invocation or new debit. All responses are private/no-store. A 404 means no matching authorized request, not permission to retry under a new identity.

get/ai/extract/requests/{requestId}

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/ai/extract/requests/{requestId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

requestIdstring uuid required

Query parameters

scope'user'

Personal workspace; mutually exclusive with org_id.

org_idstring uuid

Response

Completed extraction and document-bound receipt

operationIdstring uuid

Present on durable receipt responses.

creditState'debited' | 'exempt' | 'not_charged'

Durable outcome; API keys never inherit JWT exemptions.

cachedboolean

For durable calls, true only for not_charged cache reuse.

fieldsobject

Extracted metadata fields (keys vary by credential type)

confidencenumber

Extraction confidence score (0-1)

confidenceScoresobject nullable

API-RICH-02 per-field confidence scores from the extraction manifest.

subTypestring nullable

API-RICH-02 fine-grained credential subtype when extracted.

descriptionstring nullable

API-RICH-02 human-readable credential summary when extracted.

fraudSignalsobject[] nullable

Fraud indicators returned by /ai/extract when emitted; /verify does not return fraudSignals today.

providerstring

AI provider used (e.g., gemini, cloudflare-workers-ai)

creditsRemaininginteger nullable

AI credits remaining after extraction.

manifestHashstring

Hash of the signed extraction manifest.

degradedboolean

True when extraction ran in fallback/degraded mode. A degraded answer is a stand-in guess, not an analysis: the credit is refunded, it is never cached, and an identical retry reaches the model again.

fallbackReasonstring nullable

Reason extraction used fallback behavior, when applicable.

degradedReason'timeout' | 'provider_unavailable' nullable

Typed cause when degraded is true; null otherwise.

retryableboolean

Present and true on a degraded answer: retrying can succeed.

Changes

No recorded changes to this operation across all 1 revision of this API.