> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ratex.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Make your first RateXAI scoring request

## API Endpoint

```http theme={null}
POST https://n8n.value8.dev/webhook/scoring-api.ratex.ai
```

## Authentication

Required headers:

```http theme={null}
X-API-Key: YOUR_API_KEY
Content-Type: application/json
```

## Your First Request

Send a POST request with the required parameters: `type`, `project`, and `project_url`.

### Example Request Body

```json theme={null}
{
  "type": "posttge",
  "project": "LayerZero",
  "project_url": "https://layerzero.network",
  "token_symbol": "ZRO",
  "category": "Omnichain Protocol",
  "blockchain": "Ethereum",
  "output_format": "standard"
}
```

### Quick cURL Example

```bash theme={null}
curl -X POST https://n8n.value8.dev/webhook/scoring-api.ratex.ai \
  -H "X-API-Key: your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "posttge",
    "project": "LayerZero",
    "project_url": "https://layerzero.network",
    "output_format": "minimal"
  }'
```

### Example Minimal Response

```json theme={null}
{
  "job_id": "posttge_1737123456789_abc123xyz",
  "type": "posttge",
  "project": "LayerZero",
  "rating": {
    "band": "BBB",
    "score": 62
  },
  "trust_score": {
    "score": 85
  },
  "vfr": {
    "value": 0.97,
    "zone": "FAIR"
  },
  "execution_time_seconds": 75
}
```

No manual data input is required beyond `project` + `project_url`. The API automatically collects and cross-validates current public data during each request.

## Next Steps

<CardGroup cols={2}>
  <Card title="Request Parameters" icon="sliders" href="/api-reference/request-parameters">
    See all required and optional parameters.
  </Card>

  <Card title="Response Formats" icon="file-code" href="/api-reference/response-formats">
    Minimal, standard, and full report formats.
  </Card>

  <Card title="Code Examples" icon="terminal" href="/examples/code-examples">
    Python, cURL, and JavaScript examples.
  </Card>

  <Card title="Scoring Models" icon="chart-bar" href="/scoring/post-tge">
    Understand Post-TGE and Pre-TGE analysis.
  </Card>
</CardGroup>

<Note>
  RateXAI also offers the [MetaScore API](/api-reference/metascore-overview) for real-time score queries and the [Chain Data API](/api-reference/chain-data-overview) for indexed on-chain aggregates. See [Products & Pricing](/products/overview) for the full product suite.
</Note>