# VibeCode

> Bitrix24 App Development Platform — proxy API for AI models and developers.
> Get an API key, give it to your AI model with the docs link, and build applications.

## Marketing

- [AI Search Landing](https://vibecode.bitrix24.tech/ai-search): Public marketing page for the AI-Search product (9 providers, 2 modes, BYOK, business scenarios)

## Docs

- [Complete Documentation](https://vibecode.bitrix24.tech/llms-full.txt): All docs in one file — entities, recipes, auth, errors, infra
- [Quick Start](https://vibecode.bitrix24.tech/docs-content/quickstart.md): Get started in 5 minutes
- [Entity API](https://vibecode.bitrix24.tech/docs-content/entity-api.md): CRUD, pagination, aggregation, field formats for 40 entities
- [Filtering](https://vibecode.bitrix24.tech/docs-content/filtering.md): Three filter syntaxes with examples
- [OpenAPI 3.1](https://vibecode.bitrix24.tech/v1/openapi.json): OpenAPI specification
- [Keys & Auth](https://vibecode.bitrix24.tech/docs-content/keys-auth.md): Authentication guide
- [Scopes](https://vibecode.bitrix24.tech/docs-content/scopes.md): Full list of API key scopes and their purpose
- [Apps & Publishing](https://vibecode.bitrix24.tech/docs-content/apps.md): App lifecycle — create OAuth app, set appUrl, publish to catalog, bind placements
- [Apps — Placements](https://vibecode.bitrix24.tech/docs-content/apps/placements.md): Embed an app into the Bitrix24 UI — bind and unbind places, available codes, bind prerequisites and error codes
- [Management Keys](https://vibecode.bitrix24.tech/docs-content/management-keys.md): Cross-portal key management API
- [Error Codes](https://vibecode.bitrix24.tech/docs-content/errors.md): Error reference
- [Changelog](https://vibecode.bitrix24.tech/docs-content/changelog.md): API changelog — new features, fixes, and breaking changes (entries prefixed NEW / FIX / BC)
- [CLI & cURL](https://vibecode.bitrix24.tech/docs-content/cli.md): Command-line usage
- [Batch Operations](https://vibecode.bitrix24.tech/docs-content/batch.md): Combine up to 50 calls
- [Optimization](https://vibecode.bitrix24.tech/docs-content/optimization.md): Performance tips
- [Bot Platform](https://vibecode.bitrix24.tech/docs-content/bots.md): Build Bitrix24 chat bots
- [Infrastructure](https://vibecode.bitrix24.tech/docs-content/infra.md): Cloud server provisioning, deploy, lifecycle and access — overview of all 39 endpoints
- [Infrastructure — Providers & catalogs](https://vibecode.bitrix24.tech/docs-content/infra/providers.md): Providers, plans, regions, OS images
- [Infrastructure — Servers](https://vibecode.bitrix24.tech/docs-content/infra/servers.md): Create, list, get and delete a server
- [Infrastructure — Server access recovery](https://vibecode.bitrix24.tech/docs-content/infra/server-access-recovery.md): Server list is empty or returns 404 for a new key — rebind the controlling key
- [Infrastructure — Lifecycle](https://vibecode.bitrix24.tech/docs-content/infra/lifecycle.md): Start, stop, sleep, wake, repair the tunnel
- [Infrastructure — Scheduled wake](https://vibecode.bitrix24.tech/docs-content/infra/wake-schedules.md): Wake a sleeping server on a recurring schedule — list, create, update, delete wake windows
- [Infrastructure — Access & modes](https://vibecode.bitrix24.tech/docs-content/infra/access.md): Access policy, named users and departments, SSH, BLACKHOLE↔OPEN
- [Infrastructure — Deploy API](https://vibecode.bitrix24.tech/docs-content/infra/deploy.md): Deploy app, exec, upload, logs, port, metrics, runtimes; pass displayName + description on deploy for a readable Bitrix24 catalog card
- [Infrastructure — App icon](https://vibecode.bitrix24.tech/docs-content/infra/app-icon.md): SVG app icon — format, requirements, upload, browser-tab favicon
- [Infrastructure — Access tokens](https://vibecode.bitrix24.tech/docs-content/infra/access-tokens.md): Short-lived tokens for e2e checks and shareable links
- [Infrastructure — App runtime](https://vibecode.bitrix24.tech/docs-content/infra/app-runtime.md): What the app receives — Gateway headers, identity via /v1/me, handler skeletons
- [Infrastructure — Event subscriptions](https://vibecode.bitrix24.tech/docs-content/infra/event-subscriptions.md): Deliver Bitrix24 portal events to the app through the tunnel
- [Infrastructure — Galaxy app](https://vibecode.bitrix24.tech/docs-content/infra/galaxy.md): Dense per-host hosting — the kind model, build-on-deploy lifecycle, per-host pricing
- [Vibe Storage](https://vibecode.bitrix24.tech/docs-content/storage.md): Per-app object storage backed by S3-compatible object storage
- [Source Storage](https://vibecode.bitrix24.tech/docs-content/source-storage.md): App source code snapshots for company continuity — save_sources API + soft gate on publish
- [Telephony](https://vibecode.bitrix24.tech/docs-content/telephony.md): Call tracking and VoIP
- [Calls](https://vibecode.bitrix24.tech/docs-content/calls.md): AI follow-up summaries for finished calls — call.followup.list / call.followup.get
- [Mail](https://vibecode.bitrix24.tech/docs-content/mail.md): Read mail, send messages, convert emails to tasks/events/chats/feed posts
- [Automation](https://vibecode.bitrix24.tech/docs-content/automation.md): Business process automation
- [Workday](https://vibecode.bitrix24.tech/docs-content/workday.md): Time management
- [Scrum](https://vibecode.bitrix24.tech/docs-content/scrum.md): Scrum epics + task placement — create/rename epics, bind tasks to epics, auto-backlog, story points
- [Human Resources](https://vibecode.bitrix24.tech/docs-content/humanresources.md): Org structure — departments & teams (nodes), node members, employees. 4 subsections, 18 endpoints
- [Timeline Logs](https://vibecode.bitrix24.tech/docs-content/timeline-logs.md): CRM timeline
- [User Fields](https://vibecode.bitrix24.tech/docs-content/userfields.md): Custom field management
- [Catalog Extended](https://vibecode.bitrix24.tech/docs-content/catalog-extended.md): Product catalog
- [Feed](https://vibecode.bitrix24.tech/docs-content/feed.md): Activity feed posts
- [Chats](https://vibecode.bitrix24.tech/docs-content/chats.md): IM Chat API
- [Open Channels](https://vibecode.bitrix24.tech/docs-content/openlines.md): imopenlines module — channel configuration (CRUD: operator queue, working hours, CRM, welcome, ratings; at /docs/openlines/config) plus the contact-center dashboard (period aggregates, real-time operator load, session search, per-session stats, transfers, CSAT ratings — rolling out with imopenlines 26.700.0)
- [Notifications](https://vibecode.bitrix24.tech/docs-content/notifications.md): Send notifications to Bitrix24 users — deliver, mark as read, delete by id or tag
- [Knowledge Base 2.0](https://vibecode.bitrix24.tech/docs-content/note.md): note.* scope — create/list/get/rename/archive/delete knowledge bases (collections) and read their document tree; create/get/update/archive/delete/search documents (Markdown); upload attachments and get the ready-to-embed assetMarkdown
- [Lists](https://vibecode.bitrix24.tech/docs-content/lists.md): Universal Lists (lists.* scope) — lists, fields, sections, elements. 409 LISTS_MODULE_NOT_ENABLED when the module is off on the portal
- [Duplicate Search](https://vibecode.bitrix24.tech/docs-content/duplicates.md): Find CRM leads, contacts, and companies by phone or email
- [Stage History](https://vibecode.bitrix24.tech/docs-content/stage-history.md): CRM stage and status transition history (deals, leads, invoices)
- [Task Change History](https://vibecode.bitrix24.tech/docs-content/task-history.md): Full change history of a task in one call — kanban stage moves, sprint/backlog moves, status, responsible, deadline
- [Task Kanban Stages](https://vibecode.bitrix24.tech/docs-content/task-stages.md): Current kanban columns of a workgroup or the personal plan
- [MCP Integration](https://vibecode.bitrix24.tech/docs-content/mcp.md): Model Context Protocol
- [AI Model Router](https://vibecode.bitrix24.tech/docs-content/ai.md): OpenAI-compatible chat completions, free BitrixGPT 5
- [Web Search](https://vibecode.bitrix24.tech/docs-content/search.md): Multi-provider web search for AI agents (Bitrix24 AI Search, Tavily, Brave, Exa and 5 others)
- [Deep Research](https://vibecode.bitrix24.tech/docs-content/search/research.md): Deep multi-step agentic web research with cited sources via POST /v1/research — synthesized overview + grounded answer; see GET /v1/search/providers for available engines and pricing
- [Agents](https://vibecode.bitrix24.tech/docs-content/agents.md): Fully-managed AI agents on cloud infrastructure
- [Cowork/Code](https://vibecode.bitrix24.tech/docs-content/cowork.md): Cowork/Code desktop subscription state — current tier, quota windows (5h/week/month), and upgrade recommendation
- [Partner Connect](https://vibecode.bitrix24.tech/docs-content/partner-connect.md): External service OAuth
- [Connect Self-Hosted Bitrix24](https://vibecode.bitrix24.tech/docs-content/connect-self-hosted-bitrix24.md): Two-click onboarding for self-hosted Bitrix24 portals via companion bot
- [Includes](https://vibecode.bitrix24.tech/docs-content/includes.md): Resolve related entities via ?include=
- [Feedback](https://vibecode.bitrix24.tech/docs-content/feedback.md): Submit feedback tickets from your app
- [Entity Index](https://vibecode.bitrix24.tech/docs-content/entities-index.md): All entities overview

## Entities (43)

- [Deals](https://vibecode.bitrix24.tech/docs-content/entities/deals.md)
- [Deal Categories](https://vibecode.bitrix24.tech/docs-content/entities/deal-categories.md)
- [Pipelines](https://vibecode.bitrix24.tech/docs-content/entities/categories.md)
- [Contacts](https://vibecode.bitrix24.tech/docs-content/entities/contacts.md)
- [Companies](https://vibecode.bitrix24.tech/docs-content/entities/companies.md)
- [Leads](https://vibecode.bitrix24.tech/docs-content/entities/leads.md)
- [Quotes](https://vibecode.bitrix24.tech/docs-content/entities/quotes.md)
- [Activities](https://vibecode.bitrix24.tech/docs-content/entities/activities.md)
- [Products](https://vibecode.bitrix24.tech/docs-content/entities/products.md)
- [Product Sections](https://vibecode.bitrix24.tech/docs-content/entities/product-sections.md)
- [Statuses](https://vibecode.bitrix24.tech/docs-content/entities/statuses.md)
- [Currencies](https://vibecode.bitrix24.tech/docs-content/entities/currencies.md)
- [Requisites](https://vibecode.bitrix24.tech/docs-content/entities/requisites.md)
- [Requisite Presets](https://vibecode.bitrix24.tech/docs-content/entities/requisite-presets.md)
- [Bank Details](https://vibecode.bitrix24.tech/docs-content/entities/bank-details.md)
- [Addresses](https://vibecode.bitrix24.tech/docs-content/entities/addresses.md)
- [Requisite Links](https://vibecode.bitrix24.tech/docs-content/entities/requisite-links.md)
- [Timelines](https://vibecode.bitrix24.tech/docs-content/entities/timelines.md)
- [CRM Card Layout](https://vibecode.bitrix24.tech/docs-content/entities/crm-card-config.md)
- [Invoices](https://vibecode.bitrix24.tech/docs-content/entities/invoices.md)
- [Tasks](https://vibecode.bitrix24.tech/docs-content/entities/tasks.md)
- [Task Comments](https://vibecode.bitrix24.tech/docs-content/entities/task-comments.md)
- [Calendar Events](https://vibecode.bitrix24.tech/docs-content/entities/calendar-events.md)
- [Calendar Sections](https://vibecode.bitrix24.tech/docs-content/entities/calendar-sections.md)
- [Files](https://vibecode.bitrix24.tech/docs-content/entities/files.md)
- [Folders](https://vibecode.bitrix24.tech/docs-content/entities/folders.md)
- [Storages](https://vibecode.bitrix24.tech/docs-content/entities/storages.md)
- [Users](https://vibecode.bitrix24.tech/docs-content/entities/users.md)
- [Departments](https://vibecode.bitrix24.tech/docs-content/entities/departments.md)
- [Workgroups](https://vibecode.bitrix24.tech/docs-content/entities/workgroups.md)
- [Catalogs](https://vibecode.bitrix24.tech/docs-content/entities/catalogs.md)
- [Catalog Products](https://vibecode.bitrix24.tech/docs-content/entities/catalog-products.md)
- [Catalog Product Properties](https://vibecode.bitrix24.tech/docs-content/entities/catalog-product-properties.md)
- [Catalog Sections](https://vibecode.bitrix24.tech/docs-content/entities/catalog-sections.md)
- [Catalog Prices](https://vibecode.bitrix24.tech/docs-content/entities/catalog-prices.md)
- [Warehouses](https://vibecode.bitrix24.tech/docs-content/entities/warehouses.md)
- [Orders](https://vibecode.bitrix24.tech/docs-content/entities/orders.md)
- [Order Statuses](https://vibecode.bitrix24.tech/docs-content/entities/order-statuses.md)
- [Basket Items](https://vibecode.bitrix24.tech/docs-content/entities/basket-items.md)
- [Payments](https://vibecode.bitrix24.tech/docs-content/entities/payments.md)
- [Sites](https://vibecode.bitrix24.tech/docs-content/entities/sites.md)
- [Pages](https://vibecode.bitrix24.tech/docs-content/entities/pages.md)
- [Doc Templates](https://vibecode.bitrix24.tech/docs-content/entities/doc-templates.md)
- [Documents](https://vibecode.bitrix24.tech/docs-content/entities/documents.md)
- [Bookings](https://vibecode.bitrix24.tech/docs-content/entities/bookings.md)
- [Bizproc Templates](https://vibecode.bitrix24.tech/docs-content/entities/bizproc-templates.md)
- [Bizproc Activities](https://vibecode.bitrix24.tech/docs-content/entities/bizproc-activities.md)
- [Bizproc Robots](https://vibecode.bitrix24.tech/docs-content/entities/bizproc-robots.md)
- [Telephony Lines](https://vibecode.bitrix24.tech/docs-content/entities/telephony-lines.md)
- [Items](https://vibecode.bitrix24.tech/docs-content/entities/items.md)
- [Smart Processes](https://vibecode.bitrix24.tech/docs-content/entities/smart-processes.md)

## Recipes (13)

- [Telegram bot for CRM](https://vibecode.bitrix24.tech/docs-content/recipes/telegram-bot.md)
- [AI assistant for a deal](https://vibecode.bitrix24.tech/docs-content/recipes/ai-assistant.md)
- [CRM analytics: the sales funnel](https://vibecode.bitrix24.tech/docs-content/recipes/crm-analytics.md)
- [Task automation](https://vibecode.bitrix24.tech/docs-content/recipes/task-automation.md)
- [Email blast to contacts](https://vibecode.bitrix24.tech/docs-content/recipes/mass-messaging.md)
- [Sync with an ERP system](https://vibecode.bitrix24.tech/docs-content/recipes/erp-sync.md)
- [Working with Drive files](https://vibecode.bitrix24.tech/docs-content/recipes/disk-files.md)
- [Working with files in CRM fields](https://vibecode.bitrix24.tech/docs-content/recipes/crm-files.md)
- [Handling account events](https://vibecode.bitrix24.tech/docs-content/recipes/webhook-handler.md)
- [Web search and LLM (RAG)](https://vibecode.bitrix24.tech/docs-content/recipes/web-search-with-llm.md)
- [Load a database dump onto a server](https://vibecode.bitrix24.tech/docs-content/recipes/db-dump-restore.md)
- [Long operations via exec](https://vibecode.bitrix24.tech/docs-content/recipes/long-operations.md)
- [A fast redeploy loop](https://vibecode.bitrix24.tech/docs-content/recipes/fast-redeploy.md)

## CLI via OpenAPI

VibeCode API has a full OpenAPI 3.1 spec at /v1/openapi.json (300+ endpoints).
Use [openapi-to-cli](https://github.com/EvilFreelancer/openapi-to-cli) for instant CLI access:

```
npm install -g openapi-to-cli
ocli profile add vibecode --spec https://vibecode.bitrix24.tech/v1/openapi.json --base-url https://vibecode.bitrix24.tech --header "X-Api-Key: YOUR_KEY"
ocli vibecode search "deals"
ocli vibecode exec GET /v1/deals
```

## API Discovery (requires API key)

- GET /v1/me — key capabilities and available endpoints (X-Api-Key header)
- GET /v1/guide — complete API reference scoped to your key (X-Api-Key header)