# Getting started with Alaio Vibecode

Alaio Vibecode is a platform where artificial intelligence (AI) builds applications for Bitrix24. You describe the task in plain words — and get a working application in hours, without a developer and without development skills.

## Why it's for you

- **No programming skills required.** AI writes the code — you don't need to understand APIs, servers, or databases.
- **Hours, not months.** No need to find a developer, write a spec, and wait for weeks. From idea to a working application — one conversation with an AI model.
- **Under your control.** Access to data is granted by a key you create and revoke yourself at any time. The application runs on a dedicated server, closed off from the internet.
- **Cheaper than hiring a developer.** AI does the development; you pay for server usage and for individual features.

## What you'll need

Before you start, make sure you have:

- **A Bitrix24 account on a commercial plan.** A commercial Bitrix24 account plan unlocks the entire Vibecode platform — creating keys, accessing account data, servers, deployment, and publishing applications. A trial plan gives you limited access; on a free plan access is declined with `INT_TARIFF_REQUIRED`. On `.com` full platform access is sold as a plan of the **Vibe+** line — that is what the refusal text names, and what the pricing page sells; read the machine-readable `details.requiredTariffs` field for the plans that clear the refusal today. For cloud accounts, access can be narrowed to the Vibe+ line, and then an ordinary commercial plan is declined with `INT_VIBE_PLUS_REQUIRED`. This is an AI Beta; terms may change at any time.
- **If your Bitrix24 is self-hosted, connect it to the platform first.** The steps are in [Connecting a self-hosted Bitrix24](./connect-self-hosted-bitrix24.md). A cloud Bitrix24 account needs no separate connection.
- **An AI tool that works with files and runs commands on its own** — for example, Claude Code, Cursor, or OpenAI Codex. Such a tool doesn't just reply in a chat — it acts autonomously: it reads the documentation, creates the application files, writes code, and sends requests to the Vibecode platform. A regular AI chat, where you can only exchange messages, won't work for this — with one, you would have to perform every step by hand.

## Step 1. Create a key

A key is access to your Bitrix24 data that you hand over to the AI model. There are two kinds of keys:

- **For yourself** (`vibe_api_…`) — the application acts on your behalf. Suitable for personal summaries, reports, server-side automations, and scheduled background jobs (cron) — requests use the `X-Api-Key` header, no session token needed. Created in the [API Keys](/keys) section.
- **For a team and for embedding into your Bitrix24 account** (`vibe_app_…`) — each employee signs in through their own Bitrix24, and data requests are made on their behalf. The same key is needed for the application to open inside Bitrix24 — in the left menu, the CRM tab, or a widget (see [Placements](/docs/apps/placements)). Created in the [Auth Keys](/apps) section.

The authorization key and the employee session determine on whose behalf the application calls Bitrix24, and the key scopes determine which data and sections it can access. Which records an employee sees depends on the access the session has on the Bitrix24 account and on the application's logic, and the key itself does not filter records. If the employee's session has access to other people's records, the application shows them too unless you add a condition. To show an employee only their own records, add a separate "own records only" filter to the application: access is still set by the session and the key scopes, and the filter narrows the result within those limits. More about the session — [Application user authorization](/docs/keys-auth/oauth).

If you're not sure, start with a "for yourself" key: you can switch to a team key later. If the application must open inside Bitrix24, create an authorization key (`vibe_app_…`) right away.

For unattended automation with no user at the screen — cron, a scheduler, server-side scripts — choose an API key (`vibe_api_…`). An authorization key (`vibe_app_…`) requires an `Authorization: Bearer` header with a session token on every data request, and the session lives 24 hours with no auto-renewal — an unattended script has no way to re-authorize each day. More details — [Creating and using a key](./keys-auth.md).

1. Sign in to your Vibecode [account](/dashboard).
2. Open [API Keys](/keys) (for yourself) or [Auth Keys](/apps) (for a team and embedding into your Bitrix24 account).
3. Click **Create Key**, set a name, and select the [permissions](./scopes.md) — which data the application will be able to work with.
4. Copy the key — it is shown only once.

A detailed walkthrough of the creation form — [Creating and using a key](./keys-auth.md).

## Step 2. Give the key to the AI model

Open Claude Code, Cursor, or another AI tool and paste the prompt:

```
My API key for the Vibecode platform: vibe_api_xxx...
Documentation: https://vibecode.bitrix24.com/v1/me

Build me an application [application description] and deploy it to Vibecode
```

For an authorization key (an application for a team or with embedding into your Bitrix24 account):

```
My API key for the Vibecode platform: vibe_app_xxx...
Documentation: https://vibecode.bitrix24.com/v1/me

Build me an application [application description] with authorization, embed it into Bitrix24 and deploy it to Vibecode
```

The model calls `GET /v1/me` with your key and receives the available data, permissions, and instructions for placing the application.

## Step 3. What happens next

The AI model does everything itself:

1. Learns from your key which data and capabilities it has access to (`GET /v1/me`).
2. Writes the application code using your Bitrix24 data (deals, tasks, contacts, and others).
3. Creates a server and deploys the application via `POST /v1/infra/servers/:id/deploy`.
4. The application is available at an address like `https://app-xxx.vibecode.bitrix24.com`.

A server can also be created in advance, manually in the [Black Hole](/black-hole) section. More details — [Infrastructure](./infra.md).

## What's next

- [Creating and using a key](./keys-auth.md) — how to create a key, limit its validity period, and revoke it at any time.
- [Permissions (scopes)](./scopes.md) — what the permissions mean and which data you expose to the application.
- [Bot platform](./bots.md) — how to build a chatbot for clients or employees.

Ready-made examples: [sales funnel analytics](./recipes/crm-analytics.md), [Telegram bot for CRM](./recipes/telegram-bot.md), [mass messaging to contacts](./recipes/mass-messaging.md), [task automation](./recipes/task-automation.md), [ERP sync](./recipes/erp-sync.md).

For a developer and an AI model: [working with data](./entity-api.md), [filtering](./filtering.md), [Batch API](./batch.md), [optimization](./optimization.md), [infrastructure](./infra.md), [error codes](./errors.md).