Интеграция

Агенти и машинни формати

Всяка страница от справочника като Markdown, текст, JSON и OpenAPI — и как да насочите агент за програмиране към нея.

Тази документация се генерира от структурирани данни, така че може да се сервира във всякаква форма, която я чете. Ако интегрирате с агент за програмиране или LLM, вземете някой от файловете по-долу, вместо да разчитате тези HTML страници. Машинните формати са на английски.

Формати

Формат	URL	За какво
Markdown, една страница	`https://thecarapi.com/docs/<section>.md`	Поставяне на един раздел в промпт или хранилище.
Markdown, всичко	`https://thecarapi.com/docs/thecarapi-api-reference.md`	Целият справочник като един файл, с front matter.
Текст, всичко	`https://thecarapi.com/docs/thecarapi-api-reference.txt`	Контекстни прозорци и инструменти, които се затрудняват с Markdown таблици.
JSON	`https://thecarapi.com/docs/thecarapi-api-reference.json`	Програмен достъп до разделите, ендпойнтите, параметрите и полетата в отговорите.
OpenAPI	`https://thecarapi.com/openapi.json`	Генериране на клиенти, импорт в Postman/Insomnia, дефиниции на инструменти за агенти. OpenAPI 3.0.3 с пълни схеми на отговорите, дефиниции на параметрите и изисквания за сигурност.
Postman колекция	`https://thecarapi.com/thecarapi.postman_collection.json`	Директен импорт в Postman — всеки ендпойнт, групиран и описан.
`llms.txt`	`https://thecarapi.com/llms.txt`	Индексът на сайта по конвенцията llms.txt.
Индекс на документацията за агенти	`https://thecarapi.com/docs/llms.txt`	Само дървото на документацията, с едноредово резюме за всеки раздел.

Всяка английска страница от документацията обявява своя Markdown близнак в head като <link rel="alternate" type="text/markdown">, а бутоните за копиране и изтегляне в горната част на всяка страница създават точно тези файлове в браузъра.

Как да ги изтеглите

bash

# Един раздел
curl -sS https://thecarapi.com/docs/live-prices.md

# Целият справочник като Markdown
curl -sS https://thecarapi.com/docs/thecarapi-api-reference.md

# Повърхността на ендпойнтите като OpenAPI
curl -sS https://thecarapi.com/openapi.json | jq '.paths | keys'

Това са статични файлове. Не е нужен API ключ за четене на документацията.

Как да дадете на агента правилния контекст

Пълният справочник е голям. За повечето задачи агентът се нуждае от три неща: конвенциите, речника на данните и групата ендпойнти, която извиква. Извличането на тези три раздела е по-евтино и по-точно от изсипването на целия документ в контекстния прозорец.

text

You are integrating with TheCarApi.

Read these first:
  https://thecarapi.com/docs/conventions.md     — envelope, ETags, pagination, rate limits
  https://thecarapi.com/docs/errors.md          — status codes and what is worth retrying
  https://thecarapi.com/docs/recipes.md         — six complete flows, end to end
  https://thecarapi.com/docs/<group>.md         — the endpoint group you are calling
  https://thecarapi.com/openapi.json            — machine-readable parameter and response shapes

Rules that are not obvious from the schema:
  - A vehicle is addressed by site_name + auction_id_str, e.g. encar/38112900.
  - Prices are JSON numbers, never strings.
  - An absent live_price block is normal, not an error.
  - Never hardcode the source list; read /api/sites and /api/contract at startup.
  - Retry 429/503 honouring Retry-After. Never retry 400/401/403/404.

Начален промпт (на английски, както и машинните формати). Заменете <group> със search, auctions, car-details и т.н.

Политика за обхождане

robots.txt разрешава роботите за търсене и AI цитиране и забранява масовите събирачи на данни за обучение. Документацията е публична и без удостоверяване; API зад нея не е. Нищо в тези файлове не е идентификационни данни. Ендпойнтите с данни изискват ключ; проверките за работа и готовност и върнатите адреси за доставка на протоколи/снимки са изключения.