> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chattler.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ներածություն

> Բազային URL, նույնականացում և բոլոր էնդփոինթների համար ընդհանուր պայմանավորվածություններ:

<Note>
  Այս բաժնի էնդփոինթների էջերը (հարցման և պատասխանի սխեմաները և խաղահրապարակը) ստեղծվում են OpenAPI սխեմայից և հասանելի են միայն անգլերենով: Այս լեզվով ուղեցույցները նկարագրում են նույն վարքը:
</Note>

## Բազային URL

Բոլոր էնդփոինթները գտնվում են `https://api.chattler.ai/v1`-ի տակ: Սպասարկվում է միայն HTTPS:

## Նույնականացում

Յուրաքանչյուր հարցում պահանջում է API բանալի `Authorization` վերնագրում՝ `Bearer` սխեմայով: Բանալին ստեղծվում է Chattler հավելվածում; տե՛ս [Ստացեք ձեր API բանալին](/am/get-started/api-key):

```http theme={null}
Authorization: Bearer cht_live_<key_id>.<secret>
```

Բանալիները կապված են մեկ գործակալի և կրում են թույլտվություն. `read-only`՝ երկու `GET` էնդփոինթների համար, `full`՝ դրանց գումարած երկու `POST` չատ-էնդփոինթների համար:

## Պայմանավորվածություններ

* Հարցման և պատասխանի մարմինները JSON են (`Content-Type: application/json`), բացառությամբ հոսքային էնդփոինթի, որը պատասխանում է `text/event-stream`-ով:
* Երկու չատ-էնդփոինթները պահանջում են `Idempotency-Key` վերնագիր, 1-255 նիշ, եզակի յուրաքանչյուր տրամաբանական հարցման համար: Տե՛ս [Իդեմպոտենտություն](/am/guides/idempotency):
* Յուրաքանչյուր պատասխան կրում է `X-Request-ID`: Հարցումների սահմանաչափի վերնագրերը՝ `X-RateLimit-Limit`, `X-RateLimit-Remaining` և `X-RateLimit-Reset`, առկա են JSON `200` պատասխաններում և `429`-ում; SSE հոսքը և մյուս սխալի պատասխանները դրանք չեն կրում: Տե՛ս [Հարցումների սահմանաչափեր](/am/guides/rate-limits):
* Յուրաքանչյուր ձախողում `{"error": {"code", "message", "request_id"}}` է: Տե՛ս [Սխալներ](/am/guides/errors):
* Ցանկերը `{"data": [...], "next_cursor": "..." | null}` են; `limit`-ը 1-100 է, լռելյայն 20:
* Ժամանակի դրոշմները ISO-8601 են UTC-ով: Զտիչներն ընդունում են ժամային գոտիով կամ առանց գոտու արժեքներ (առանց գոտու արժեքը կարդացվում է որպես UTC); `date_to`-ն բացառող է:

## Փորձեք խաղահրապարակում

Էնդփոինթների էջերն ունեն խաղահրապարակ: Տեղադրեք իրական բանալի որպես bearer թոքեն և օգտագործեք այն գործակալի նույնացուցիչը, որին պատկանում է բանալին; հարցումներն ուղիղ գնում են `https://api.chattler.ai` և վճարվում են ինչպես ցանկացած այլ կանչ:

<Warning>
  Մի՛ տեղադրեք `full` բանալի ընդհանուր էկրանում կամ ձայնագրության մեջ: Եթե տեղադրել եք, թարմացրեք այն հավելվածում:
</Warning>