BigMindBigMindBigMind
Partner APIBETA
Sign inGet an API key
Partner APIBETA
OverviewAuthenticationCustomersPlansAccount & UsageDICOM ReportsWebhooksError codesChangelog

Error codes

All errors share the same envelope. Match on error.code (machine-readable) — error.message is for humans and may change between releases.

CodeStatusWhen you'll see it
UNAUTHENTICATED401No API key on the request.
INVALID_API_KEY401API key is wrong, revoked, or the partner account is inactive.
RATE_LIMITED429Exceeded 120 requests/minute. Wait per the Retry-After header.
TRIAL_EXPIRED403Partner trial expired. Cannot create new customers until upgraded.
CANNOT_SELL403Partner tier does not permit selling customers. Upgrade tier.
VALIDATION_FAILED400Request body or query params failed validation. See `details` array for per-field errors.
INSUFFICIENT_CREDITS400Partner credits balance is below the required charge. `details` includes `required`, `current`, and (on create) a `breakdown`.
CUSTOMER_NOT_FOUND404Customer ID does not exist or belongs to a different partner.
CUSTOMER_EXISTS409A customer with that email already exists under your partner account.
INVALID_PLAN404Plan ID not found, inactive, or not enabled for this partner.
PLAN_NOT_ENABLED400Plan exists but is not enabled in your retail pricing, or required pricing setup is missing.
FORBIDDEN400Operation not allowed for the customer's current state (e.g., suspending a deleted customer, or partner trying to delete a user-uploaded file).
STUDY_NOT_FOUND404DICOM study UID not found in this customer, or not yet indexed in AI Lens. Returned identically for both — no cross-tenant info leak.
STORAGE_FULL402Customer storage quota exceeded. `details` includes `quotaGB`, `usedBytes`, `requiredBytes`.
FILE_TOO_LARGE400Uploaded report exceeds the 25 MB limit.
INVALID_REPORT_TYPE400Uploaded report must be PDF, DOC, DOCX, or TXT.
REPORT_NOT_FOUND404Report ID does not exist for this customer.
INTERNAL_ERROR500Unexpected server error. Safe to retry after a short delay.

How to read the response

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "Insufficient credits. Need 150.00 credits for this plan with add-ons.",
    "details": {
      "required": 150,
      "current": 50,
      "breakdown": {
        "basePlanCost": 100,
        "addOnCost": 50,
        "aiLensMedicalCost": 0,
        "total": 150
      }
    }
  }
}