# README

Production-ready documentation for [docs.krosai.com](https://docs.krosai.com/).

## Structure

```
developer-docs/
├── mint.json                 # Mintlify/GitBook config
├── introduction.mdx          # Landing page
├── quickstart-phone.mdx      # 5-minute quickstart
├── authentication.mdx        # API key guide
├── sdks.mdx                  # SDK installation guide
├── numbers/
│   ├── buy-numbers.mdx       # Phone Numbers API
│   ├── port-numbers.mdx      # Number porting guide
│   └── countries.mdx         # Coverage reference
├── voice/
│   ├── endpoints.mdx         # Endpoints API
│   ├── outbound-calls.mdx    # Outbound Calls API
│   ├── call-logs.mdx         # Call Logs API
│   └── recordings.mdx        # Call recordings guide
├── integrations/
│   ├── vapi.mdx              # Vapi setup guide
│   ├── retell.mdx            # Retell setup guide
│   ├── elevenlabs.mdx        # ElevenLabs setup guide
│   └── livekit.mdx           # LiveKit setup guide
├── webhooks/
│   ├── overview.mdx          # Webhooks guide
│   └── events.mdx            # Event types reference
└── reference/
    ├── error-codes.mdx       # Error reference
    ├── rate-limits.mdx       # Rate limiting info
    └── openapi.mdx           # OpenAPI spec link
```

## Deployment

{% stepper %}
{% step %}

### Connect the repository

Connect this folder to GitBook or Mintlify.
{% endstep %}

{% step %}

### Configure OpenAPI sync

Set the OpenAPI sync URL to: `https://api.krosai.com/v1/openapi.json`
{% endstep %}

{% step %}

### Set custom domain

Set the custom domain to: `docs.krosai.com`
{% endstep %}

{% step %}

### Enable AI search

Enable AI search for enhanced documentation discoverability.
{% endstep %}
{% endstepper %}

## Extending

Add more pages following the MDX format, then update `mint.json` navigation.


---

# 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.krosai.com/developer-docs/readme.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.