API Overview

Chab exposes a versioned /v1 API. The API is designed for curl, scripts, automation systems, and the Chab CLI. Hosted MCP is a separate OAuth transport for connected MCP clients; see Hosted MCP.

Base URL

https://www.chab.ai/v1

This is the production API base URL.

Response Shapes

Completed responses return data plus metadata:

{
  "data": {
    "status": "ok"
  },
  "meta": {
    "request_id": "req_123"
  }
}

Credit metadata appears only on endpoints that document credit estimates or charges.

Inline data is limited to 1 MB after JSON serialization unless an endpoint documents a smaller limit. Larger results are returned as artifacts or files.

For client generation, import the generated OpenAPI specification. It covers callable /v1 endpoints in the current release.

Async responses return an operation object:

{
  "operation": {
    "id": "op_01JZ7H0A1B2C3D4E5F6G7H8J9K",
    "status": "queued",
    "status_url": "/v1/operations/op_01JZ7H0A1B2C3D4E5F6G7H8J9K",
    "result_url": "/v1/operations/op_01JZ7H0A1B2C3D4E5F6G7H8J9K/result",
    "estimated_credits": 0
  },
  "meta": {
    "request_id": "req_123"
  }
}

Operation status and result URLs are callable through the operation status and result endpoints.

Errors return a stable error envelope:

{
  "error": {
    "code": "validation_failed",
    "message": "One or more fields failed validation.",
    "retryable": false,
    "details": {
      "simulate_async": [
        "The simulate async field must be true or false."
      ]
    }
  },
  "request_id": "req_123"
}

error.details is present only when an error carries structured field-level information, such as validation_failed. Other errors omit the key.

Endpoint Families

API families include current callable areas and planned areas:

• foundation endpoints for health, identity, errors, and echo setup tests
• search and SEO data
• business and maps data
• scraping and markdown extraction
• screenshots
• file upload, conversion, artifacts, and exports
• contact discovery and email verification
• translation
• LLM model catalog, generation, and embeddings
• deep research
• LLM streaming and expanded model options are planned, not callable unless documented
• usage, billing, tokens, projects, and webhook management
• project-connected mail and cloud drives

Each callable endpoint has its own page or section in these docs.