v2 va v3 dan v1 ga oʻting
/v1 API barcha mahsulotlarni saqlaydi, lekin yoʻllar, kalit yuboriladigan sarlavha, javob va xato tanalari hamda baʼzi maydon nomlari oʻzgaradi. Bu sahifada barcha oʻzgarishlar keltirilgan.
Nima oʻzgaradi
- Barcha mahsulotlar bitta asosiy URL manzilga koʻchadi:
https://my.neuronai.uz/api/v1. - Kalit
X-Api-KeyoʻrnigaAuthorization: Bearerda yuboriladi. successendi yoʻq: JSON javobdadatavarequest_idboʻladi, barcha xatolar esa oʻzgarmas kodli yagona shaklga ega.- Barcha maydon nomlari snake_case da yoziladi, vaqt belgilari esa
Zbilan tugaydi. - Kalitlar faqat bir marta koʻrsatiladi va tanlangan mahsulotlar bilan cheklanishi mumkin. Mavjud kalitlaringiz toʻliq ruxsatga ega, shuning uchun ishlashda davom etadi.
- Eski yoʻllar olib tashlandi va 404 bilan javob beradi. Kodingizni quyidagi yoʻllarga oʻtkazing.
Yoʻllar
Aksariyat yoʻllarda faqat versiya oʻzgaradi. Yoʻlda yana nima oʻzgargani izohlarda aytilgan.
| Avval | Hozir |
|---|---|
POST /api/v3/tts/synthesize | POST /api/v1/tts/synthesize |
POST /api/v3/tts/dialogue | POST /api/v1/tts/dialogueEndi |
POST /api/v3/tts/jobs | POST /api/v1/tts/jobs |
GET /api/v3/tts/jobs/{id} | GET /api/v1/tts/jobs/{id} |
GET /api/v3/tts/jobs/{id}/audio | GET /api/v1/tts/jobs/{id}/audio |
GET /api/v3/tts/voices | GET /api/v1/tts/voices?type=stockRoʻyxat sahifalab keladi: |
GET /api/v3/tts/my-voices | GET /api/v1/tts/voices?type=custom
|
POST /api/v3/tts/voices | POST /api/v1/tts/voicesEndi |
PUT /api/v3/tts/voices/{id} | PATCH /api/v1/tts/voices/{id}Faqat JSON. Faqat oʻzgaradigan maydonlarni yuboring. |
POST /api/v3/tts/voices/{id} (_method=PUT) | POST /api/v1/tts/voices/{id}/audioNamunaviy audioni almashtiradi, |
DELETE /api/v3/tts/voices/{id} | DELETE /api/v1/tts/voices/{id}Tanasiz 204 bilan javob beradi. |
POST /api/v2/stt/transcribe | POST /api/v1/stt/transcribe |
GET /api/v2/user/balance | GET /api/v1/balanceYangi tana: quyiga qarang. |
GET /api/v1/balance | GET /api/v1/balanceYangi tana: quyiga qarang. |
GET /api/v1/usage | GET /api/v1/usageYangi tana: quyiga qarang. |
POST /api/v2/tts/synthesize | POST /api/v1/tts/synthesizeMP3 mexanizmi ishdan chiqarilgan: /v1 oʻz ovozlari bilan WAV sintez qiladi. |
GET /api/v2/tts/voices | GET /api/v1/tts/voicesMP3 mexanizmi ishdan chiqarilgan: /v1 oʻz ovozlari bilan WAV sintez qiladi. |
OpenAI va Cohere bilan mos endpointlar oʻz yoʻllari va muvaffaqiyatli javob tanalarini saqlaydi: /api/v1/chat/completions, /api/v1/models, /api/v1/embeddings, shuningdek /api/v1/rerank va uning Cohere uchun egizagi /api/v2/rerank. Faqat ularning xatolari quyida aytilganidek oʻzgaradi.
Autentifikatsiya
Har bir soʻrovda kalitni Authorization: Bearer nai_… sifatida yuboring; X-Api-Key endi hujjatlarda yoʻq. Ovozlar roʻyxatiga yuborilgan kalit endi tekshiriladi, shuning uchun notoʻgʻri kalit ommaviy roʻyxat oʻrniga 401 javobini oladi.
Javob tanalari
success olib tashlandi, chunki buni holat bildiradi. Koʻchirilgan endpointlarda obyekt data ichida, roʻyxat esa data ichida next_cursor bilan keladi va har bir shunday tanada request_id bor. Yaratish 201, navbatga qoʻyilgan vazifa Location bilan 202, oʻchirish esa tanasiz 204 bilan javob beradi.
Ovozlar roʻyxati sukut boʻyicha 50 tadan, limit bilan 100 tagacha sahifalarda keladi. Keyingi sahifa uchun oxirgi next_cursor ni cursor sifatida bering, toki next_cursor null boʻlmaguncha.
Xatolar
Endi har bir xato bitta tanaga ega: type, code, message va param maydonli error, soʻng request_id. Tekshiruv xatosi fields ni qoʻshadi, unda har bir maydonning birinchi xabari beriladi, avval esa errors ularning hammasini sanab oʻtardi. Qarorni xabar matniga emas, error.code ga qarab qabul qiling.
voice_id is not available for your account xabari oʻz soʻzlarini saqlaydi, lekin uning oʻrniga voice_unavailable kodini tekshiring.
Idempotency-Key ni boshqa tana bilan qayta ishlatish endi 409 idempotency_conflict javobini oladi. Eski yoʻllar esa birinchi javobni indamay qaytarardi.
OpenAI bilan mos endpointlarda xato obyektiga param va request_id qoʻshiladi, rad etilgan kalit esa sababini code da aytadi, masalan avval invalid_api_key boʻlgan joyda api_key_revoked.
Nomi oʻzgargan maydonlar
Barcha maydonlar snake_case da. Quyida oʻzgargan maydonlar.
Sintez vazifasi
| Avval | Hozir |
|---|---|
createdAt | created_at |
startedAt | started_at |
finishedAt | finished_at |
characterCount | character_count |
balanceAfter | balance_after |
voiceCustom | voice_custom |
latencyMs | latency_ms |
referralReward | referral_reward/v1 da olib tashlandi. Taklif qilgan foydalanuvchiga toʻgʻridan-toʻgʻri xabar beriladi. |
audioUrl | audio_url/v1 audio endpointiga olib boradi. |
Ovoz
| Avval | Hozir |
|---|---|
refText | ref_text |
createdAt | created_at |
tags | tagsDoim roʻyxat, hech qachon |
typeYangi maydon: |
Transkripsiya
| Avval | Hozir |
|---|---|
durationSeconds | duration_seconds |
requestId | request_id
|
referralReward | referral_reward/v1 da olib tashlandi. Taklif qilgan foydalanuvchiga toʻgʻridan-toʻgʻri xabar beriladi. |
Balans
| Avval | Hozir |
|---|---|
sttPricePerSecond | stt_price_per_second |
ttsPricePerChar | tts_price_per_char |
minTopup | min_topup |
Sarf
| Avval | Hozir |
|---|---|
by_key[].api_key_id | by_key[].idKalitning ommaviy identifikatori yoki boshqaruv panelidan kelgan soʻrovlar uchun |
period.start | period.startEndi |
Vaqt belgilari UTC boʻyicha RFC 3339 formatida va avvalgi +00:00 oʻrniga Z bilan tugaydi.
Sarlavhalar
| Sarlavha | Nima oʻzgardi |
|---|---|
X-Request-Id | Har bir javobda bor. U doim joriy soʻrovni, jumladan takrorlanganini ham bildiradi. |
X-Referral-Reward | /v1 da olib tashlandi. Taklif qilgan foydalanuvchiga toʻgʻridan-toʻgʻri xabar beriladi. |
X-Audio-Url | Endi yuborilmaydi. |
X-Character-CountX-BalanceX-Voice-Custom | Endi dialog javoblarida ham yuboriladi. |
X-Turns | Kalitlar oʻsha, vaqt siljishlari esa doim kasr sonlar. |
Idempotency-Replayed | Endi transkripsiya yoki ovoz yaratish takrorlanganda ham yuboriladi. |
API kalitlar
Endi kalitlar faqat xesh sifatida saqlanadi, shuning uchun kalit bir marta, yaratilganda koʻrsatiladi va boshqa hech qachon koʻrsatilmaydi. Kalitni yoʻqotgan boʻlsangiz, yangisini yarating, ilovalaringizni unga oʻtkazing va eskisini chaqirib oling.
Ruxsatlar paydo boʻlishidan oldin yaratilgan barcha kalitlar toʻliq ruxsatga ega, shuning uchun hech narsa ishlashdan toʻxtamaydi. Yangi kalitlarga faqat kerakli mahsulotlarni bering.