API Reference

CVAI Analysis API

Use the REST API to create analysis jobs, manage credits, and retrieve structured insights programmatically. All responses follow a standard envelope with data and meta fields.

Analysis

5 endpoints

Response Format

Success Response

{
  "data": { ... },
  "meta": {
    "timestamp": "ISO-8601",
    "version": "v1"
  }
}

Error Response

{
  "error": {
    "code": "PAYMENT_REQUIRED",
    "message": "Insufficient credits",
    "details": "Balance: 0, required: 1"
  },
  "meta": {
    "timestamp": "ISO-8601",
    "version": "v1"
  }
}

Error Codes

401

UNAUTHORIZED

Not logged in

403

FORBIDDEN

Insufficient permissions

402

PAYMENT_REQUIRED

Not enough credits

400

VALIDATION_ERROR

Invalid request body

404

NOT_FOUND

Resource not found

429

RATE_LIMIT_EXCEEDED

Too many requests

Analysis Job Lifecycle

PENDING

PROCESSING

DELIVERED

FAILED

Credits are reserved when a job is created (PENDING).

On DELIVERED, the reserved credit is spent (permanent deduction).

On FAILED, the reserved credit is released back to your balance.