App blueprints

A library of ready-made technical specs for popular Bitrix24 apps — dashboards, AI bots, calculators. The user picks a blueprint in the Vibecode dashboard and copies a prompt for their AI agent. The prompt carries a link to the raw spec markdown at this endpoint — the agent downloads the spec with the same API key and builds the app from it. The section has one endpoint — fetching a blueprint's spec.

Scope: none required — works with any key bound to a Bitrix24 account (personal or OAuth application) · Base URL: https://vibecode.bitrix24.com/v1 · Authorization: X-Api-Key header

Blueprint availability

Blueprints are opened to Bitrix24 accounts in turn, and the Vibecode team turns them on — there is no such setting on the account side. The signs that the section is not open yet: the Vibecode dashboard has no "App blueprints" item, and a spec request answers 403 with the BLUEPRINTS_DISABLED code. To have the section opened, contact support.

How it works

1. The user opens the "App blueprints" section in the Vibecode dashboard (/blueprints) or picks a blueprint in the key-creation dialog.
2. The user copies the AI prompt — it contains the app name and a link of the form GET /v1/app/blueprints/:slug (with a locale parameter), to be fetched with the user's own key.
3. The AI agent (Claude Code, Cursor, and similar) makes the request with its own API key and receives the raw spec markdown — then builds the app from that text.

The list of available slug values isn't published as a separate V1 endpoint — the agent only needs the link from the copied prompt. There's no need to look up a slug in advance.

Get a blueprint spec

GET /v1/app/blueprints/:slug

Returns the raw spec markdown. The response is not a JSON envelope — the response body is the spec text as-is, with Content-Type: text/markdown; charset=utf-8.

Parameters

Examples

curl — personal key

curl "https://vibecode.bitrix24.com/v1/app/blueprints/tasks-report?locale=en" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/app/blueprints/tasks-report?locale=en" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/app/blueprints/tasks-report?locale=en', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const specMarkdown = await res.text()

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/app/blueprints/tasks-report?locale=en', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const specMarkdown = await res.text()

Response

On success — HTTP 200 with a text/markdown; charset=utf-8 body (not JSON) and a Cache-Control: no-store header (the response is deliberately not cached — the platform counts blueprint fetches from these requests).

Response example

Body excerpt for slug=tasks-report:

# Tasks report

## What the app does
An embeddable Bitrix24 report for a team lead. It answers three questions on one screen: which tasks
are already overdue, what each assignee is busy with, and how the status picture shifted over the week.

## Screens and features
- Top KPI row: total active tasks, overdue, completed this week, average time-to-close.
- An "assignee × active × overdue × completed" table, sorted by overdue count.

Error response example

404 — unknown or hidden slug:

{
  "success": false,
  "error": { "code": "BLUEPRINT_NOT_FOUND", "message": "Blueprint not found" }
}

Errors

Full list of common API errors — Errors.

Known specifics

• The response is not JSON. Read the body as text (res.text()), not res.json().
• The locale parameter defaults to en. A misspelled or unsupported value silently returns the English spec instead of an error.
• The blueprint list and the slug values have no dedicated V1 endpoint — the "App blueprints" section and the key-creation dialog in the dashboard already substitute the correct link into the copied prompt.
• Spec bodies do not promise role-based access inside the app: the app talks to Bitrix24 through a single webhook key belonging to its owner, with the owner's rights. If the app is shared with another employee, they see exactly what the key owner sees.

See also

• Keys and authorization
• Deploy API
• API changelog