Այս բաժնի էնդփոինթների էջերը (հարցման և պատասխանի սխեմաները և խաղահրապարակը) ստեղծվում են OpenAPI սխեմայից և հասանելի են միայն անգլերենով: Այս լեզվով ուղեցույցները նկարագրում են նույն վարքը:
Բազային URL
Բոլոր էնդփոինթները գտնվում ենhttps://api.chattler.ai/v1-ի տակ: Սպասարկվում է միայն HTTPS:
Նույնականացում
Յուրաքանչյուր հարցում պահանջում է API բանալիAuthorization վերնագրում՝ Bearer սխեմայով: Բանալին ստեղծվում է Chattler հավելվածում; տե՛ս Ստացեք ձեր API բանալին:
read-only՝ երկու GET էնդփոինթների համար, full՝ դրանց գումարած երկու POST չատ-էնդփոինթների համար:
Պայմանավորվածություններ
- Հարցման և պատասխանի մարմինները JSON են (
Content-Type: application/json), բացառությամբ հոսքային էնդփոինթի, որը պատասխանում էtext/event-stream-ով: - Երկու չատ-էնդփոինթները պահանջում են
Idempotency-Keyվերնագիր, 1-255 նիշ, եզակի յուրաքանչյուր տրամաբանական հարցման համար: Տե՛ս Իդեմպոտենտություն: - Յուրաքանչյուր պատասխան կրում է
X-Request-ID: Հարցումների սահմանաչափի վերնագրերը՝X-RateLimit-Limit,X-RateLimit-RemainingևX-RateLimit-Reset, առկա են JSON200պատասխաններում և429-ում; SSE հոսքը և մյուս սխալի պատասխանները դրանք չեն կրում: Տե՛ս Հարցումների սահմանաչափեր: - Յուրաքանչյուր ձախողում
{"error": {"code", "message", "request_id"}}է: Տե՛ս Սխալներ: - Ցանկերը
{"data": [...], "next_cursor": "..." | null}են;limit-ը 1-100 է, լռելյայն 20: - Ժամանակի դրոշմները ISO-8601 են UTC-ով: Զտիչներն ընդունում են ժամային գոտիով կամ առանց գոտու արժեքներ (առանց գոտու արժեքը կարդացվում է որպես UTC);
date_to-ն բացառող է:
Փորձեք խաղահրապարակում
Էնդփոինթների էջերն ունեն խաղահրապարակ: Տեղադրեք իրական բանալի որպես bearer թոքեն և օգտագործեք այն գործակալի նույնացուցիչը, որին պատկանում է բանալին; հարցումներն ուղիղ գնում ենhttps://api.chattler.ai և վճարվում են ինչպես ցանկացած այլ կանչ: