# Overview

## Overview

This Internal API allows partner services to register their users directly into our platform. Each request must include a valid API key and is strictly authenticated. Users registered via this API are automatically linked as referrals to the API key owner. This integration is ideal for platforms that want to onboard users seamlessly while tracking referrals.

## API Basics

* **Base URL: Coming Soon**

## API Versioning

Current API version is: **v1**

## API Authorization

All requests to our Internal API must include a valid API key in the **request headers.**

```
x-api-key: your-api-key-here
```

**Quick Test: Check API Version**

**Request:**

```
GET /v1/internal
Host: BASE_URL
x-api-key: your-api-key-here
```

**Example with curl:**

```
curl -X GET https://BASE_URL/v1/internal \
  -H "x-api-key: your-api-key-here"
  
```

Response:

```json
{
  "version": "v1"
}
```

### Requesting an API key

If you want to integrate with our platform and need an API key, please reach out to us directly:

📩 Contact: TBA

Our team will review your request and provide you with an API key if the integration is approved.

## Rate Limits <a href="#rate-limits" id="rate-limits"></a>

To ensure fair usage of the API, rate limits are enforced:

* **100 requests per 15-minute window** per IP address
* Exceeding this limit will result in HTTP 429 (Too Many Requests) responses

## Error Response Format

All API error responses follow a consistent format:

### Error Response

```json
{
  "message": "ERROR_MESSAGE",
  "error": "ERROR_REASON",
  "statusCode": "ERROR_CODE"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.something.cool/internal-api/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.