Skip to main content

CvdsError

Standard error envelope returned by every CV DeepSearch endpoint on a non-2xx response.

error objectrequired
codestringrequired

Stable machine-readable error code.

  • INVALID_INPUT — a field failed validation.
  • UNAUTHENTICATED — no API key / session, or it could not be resolved to a client (401).
  • MISSING_PERMISSION — invalid key or the client lacks the cvdeepsearch permission (403).
  • MISSING_CORPUS_ID — a mandatory corpus_id was missing (fail-closed; the request is rejected, never merged into a default corpus).
  • MISSING_CLIENT_ID — an admin session acted without a resolvable client.
  • BATCH_TOO_LARGE — more than 500 candidates in one ingest.
  • INSECURE_WEBHOOK_URL — webhook_url is http://.
  • PRIVATE_WEBHOOK_URL — webhook_url resolves to a private / loopback / link-local address.
  • STEP_FUNCTIONS_FAILED — the downstream search pipeline failed to start (502); retry-safe.
  • NOT_FOUND — no candidate/run with that id for this client (also returned cross-tenant).
  • INTERNAL_ERROR — uncategorised server error.

Possible values: [INVALID_INPUT, UNAUTHENTICATED, MISSING_PERMISSION, MISSING_CORPUS_ID, MISSING_CLIENT_ID, BATCH_TOO_LARGE, INSECURE_WEBHOOK_URL, PRIVATE_WEBHOOK_URL, STEP_FUNCTIONS_FAILED, NOT_FOUND, INTERNAL_ERROR]

messagestringrequired

Human-readable message.

requestIdstringnullable

Correlation id for this error response (not the run id).

timestampdate-timerequired
details object

Code-specific structured detail. May be {}.

property name*any

Code-specific structured detail. May be {}.

CvdsError
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "requestId": "string",
    "timestamp": "2024-07-29T15:51:28.071Z",
    "details": {}
  }
}