REST API

Authentication

Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here
Content-Type: application/json

Get your API key from the Settings page in your dashboard.

Endpoints

Example Request

Here's an example of generating a staging model using the API:

curl -X POST https://datachonk.dev/api/generate \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "staging",
    "source": "raw.stripe.payments",
    "options": {
      "addTests": true,
      "addDocs": true
    }
  }'

Response Format

All API responses are JSON and follow this structure:

{
  "success": true,
  "data": {
    "code": "-- Generated SQL...",
    "schema": "version: 2\nmodels:...",
    "tests": ["not_null", "unique"],
    "warnings": []
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z",
    "tokensUsed": 1250
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_SOURCE",
    "message": "Source table not found: raw.stripe.payments",
    "details": {
      "suggestion": "Check that the source exists and you have access"
    }
  },
  "meta": {
    "requestId": "req_xyz789"
  }
}

Error Codes

SDKs & Libraries

Official client libraries are coming soon. In the meantime, use the CLI or REST API directly.