<!-- Source: https://docs.vinsi.ai/getting-started/ai-assistants -->
# Using VINSI with AI Assistants

These docs are published in formats Claude, ChatGPT, Gemini, and coding agents can read directly — so they can answer questions about VINSI and build integrations with the API.

Created: September 16, 2026

Updated: September 16, 2026

## Overview

Every page on this site is also available as plain Markdown, and the whole site is indexed in an `llms.txt` file — the standard way for AI tools to discover documentation. The API Reference is also published as an OpenAPI specification. These files are regenerated every time the docs are updated.

## Machine-Readable Docs

| URL                                                   | What it is                                                                                                                    |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [/llms.txt](https://docs.vinsi.ai/llms.txt)           | Index: what VINSI is, how the API works, and a link and summary for every page.                                               |
| [/llms-full.txt](https://docs.vinsi.ai/llms-full.txt) | Every page in one Markdown file — paste or attach it to give an assistant full context.                                       |
| /<page>.md                                            | Markdown for a single page — add .md to any docs URL, e.g. [/telephony/queues.md](https://docs.vinsi.ai/telephony/queues.md). |
| [/openapi.json](https://docs.vinsi.ai/openapi.json)   | OpenAPI 3.1 spec for the REST API.                                                                                            |
| [/sitemap.xml](https://docs.vinsi.ai/sitemap.xml)     | All documentation pages.                                                                                                      |

## Pointing an Assistant at VINSI

Assistants that can browse will read the docs when you give them the link. For example:

Example prompt

```
Read https://docs.vinsi.ai/llms.txt and the pages it links to.
Then walk me through setting up a call queue for my support team
with business hours and a callback option.
```

- **Chat assistants** (Claude, ChatGPT, Gemini): share the `llms.txt` link, or attach `llms-full.txt` if browsing is off.
- **Coding agents** (Claude Code, Cursor, Codex): add `https://docs.vinsi.ai/llms.txt` to your project instructions so the agent looks things up before writing integration code.
- **Custom GPTs, Gemini Gems, Claude Projects**: add `llms-full.txt` as a knowledge file.

## Using the API

- Base URL: `https://dashboard.vinsi.ai`
- Authentication: header `x-api-key: sk_…` — see [API Keys](https://docs.vinsi.ai/account/apiKeys).
- Request and response bodies are JSON.

### What the API Can and Can't Do

The documented endpoints cover AI phone agents, calls, phone numbers, tools, and voices (see API Reference in the sidebar). Most other features — phone system setup, queues, CRM administration, billing, and organization settings — are managed in the dashboard. For those, an assistant should guide you through the exact menus and buttons described in these guides rather than calling the API.

## OpenAPI for Tools & Agents

Import `https://docs.vinsi.ai/openapi.json` into tools that accept OpenAPI — for example a ChatGPT custom GPT action, an MCP or agent framework that turns OpenAPI into tools, Postman, or a code generator. Configure the `x-api-key` header as API-key authentication.

## Keeping Keys Safe

- Never paste an API key into a chat. Give assistants a placeholder and set the real key in your code's environment variables.
- Create a separate key for each tool or agent so you can revoke one without affecting others.
- Review what an agent will do before letting it place calls or change agents with a live key.