Versiya
Əsas versiya yolda göstərilir: /api/v1. v1 daxilində mövcud inteqrasiyaları sındırmırıq. Müqavilənin cari versiyası /openapi.json faylındakı info.version dəyəridir; o, hər dəyişikliklə artır.
Xəbərdarlıqsız nə dəyişə bilər
Bu dəyişikliklər uyğundur və klientiniz onların öhdəsindən gəlməlidir:
- yeni əməliyyatlar və alətlər;
- sorğunun yeni istəyə bağlı sahələri;
- cavabın yeni sahələri;
- cavab siyahılarında (statuslar, kodlar) yeni dəyərlər,
titledaxilində yeni xəta kodları, yeni vebhuk hadisə tipləri; detailmətninin dəyişməsi;- daha yüksək limitlər.
Klientin yazılması
- Cavabın naməlum sahələrinə məhəl qoymayın.
- Naməlum siyahı dəyərini, xəta kodunu və ya hadisə tipini xəta kimi deyil, «digər» kimi qəbul edin.
- Məntiqi
detailmətni üzrə deyil,status,titlevəcodeüzrə qurun. - Sahələrin sırasına və ya id-nin uzunluğuna güvənməyin.
- Alətin xam
statusdəyərinə deyil, tapşırığınstatedəyərinə güvənin.
Nə sındırıcı dəyişiklik sayılır
Əməliyyatın, sahənin, scope-un və ya hadisənin silinməsi və ya adının dəyişdirilməsi; sorğunun yeni mütləq sahəsi; sahənin tipinin və ya mənasının dəyişməsi; eyni hal üçün status kodunun dəyişməsi; icazəli dəyərlərin daraldılması. v1 daxilində belə dəyişiklikləri xəbərdarlıqsız etmirik: əməliyyat əvvəlcə /openapi.json faylında və bu jurnalda deprecated kimi işarələnir və ən azı 6 ay işləməyə davam edir. İstisna - zəifliyin aradan qaldırılmasıdır.
Cavabı bu sənədlərə uyğunlaşdıran düzəliş sındırıcı dəyişiklik deyil.
Dəyişikliklər jurnalı
2026-11-09 - versiya 1.21
Əlavə edildi:
POST /site/createüçünPrefer: respond-asyncrejimi: dərhal sorğu tapşırığı ilə202;GET /site/create/jobs/{id}(pulsuz)resultdaxilində əvvəlki200cavabını verir. Hadisələrsite.completed/site.failed. Başlıq olmadan heç nə dəyişmir.- SDK 1.11.0:
site.createrespondAsyncseçimini qəbul edir.
2026-11-08 - versiya 1.20
Əlavə edildi:
POST /draft/extractüçünPrefer: respond-asyncrejimi: fayllar yüklənir və dərhal sorğu tapşırığı ilə202gəlir;GET /draft/extract/jobs/{id}(pulsuz)resultdaxilində əvvəlki200cavabını verir. Hadisələrdraft.completed/draft.failed. Başlıq olmadan heç nə dəyişmir.- SDK 1.10.0:
draft.extractrespondAsyncseçimini qəbul edir.
2026-11-08 - versiya 1.19
Əlavə edildi:
review.action_requiredhadisəsi: hesabatın yoxlanması sənədi oxuyub vəPOST /valuation/review/jobs/{id}/confirmgözləyir. Hər yoxlama üçün bir dəfə, onun id-si ilə gəlir,Prefer: respond-asyncilə işə salındıqda da. Əvvəllər bunu yalnız sorğu ilə öyrənmək olardı.
2026-11-06 - versiya 1.18
Əlavə edildi:
POST /floorplan/createvəPOST /valuation/reviewüçünPrefer: respond-async: fayllar qəbul edilir, sonra dərhal sorğu tapşırığı (areq_…kimijobId) vəLocation,Retry-After,Preference-Appliedbaşlıqları ilə202. Status: eyni yolda,GET /floorplan/create/jobs/{id}vəGET /valuation/review/jobs/{id}(pulsuz);resultbaşlıqsız sorğudakı ilə eyni202gövdəsini ehtiva edir (hesabatın yoxlanması yenə dəconfirmtələb edir). Başlıq olmadan heç nə dəyişmir.- Xidmətin yenidən başladılması ilə kəsilmiş sorğu tapşırığı
code: interruptediləfailedvəziyyətində bitir: heç bir ödəniş tutulmur vəIdempotency-Keyazad edilir - eyni sorğunu eyni açarla yenidən göndərin. - SDK 1.9.0:
floorplan.createvəvaluation.reviewrespondAsyncparametrini qəbul edir;interruptedsonrası klient eyni formanı eyni açarla özü yenidən göndərir, ən çoxu iki dəfə.
2026-11-05 - versiya 1.17
Əlavə edildi:
POST /valuation/expressvəPOST /valuation/rentüçünPrefer: respond-async: dərhal tapşırıq vəLocation,Retry-After,Preference-Appliedbaşlıqları ilə202. Status:GET /valuation/express/jobs/{id}vəGET /valuation/rent/jobs/{id}(pulsuz);resultsinxron200ilə eyni gövdəni,errorisə eyni problemi ehtiva edir. Başlıq olmadan çağırışlar sinxron qalır.- Vebhuk hadisələri
express.completed,express.failed,rent.completed,rent.failed. - SDK 1.8.0:
Idempotency-Keyavtomatik yaradılır; bağlantı qırıldıqdan, vaxt bitdikdən,502,504,524və409 idempotency_conflictsonrası çağırış eyni açarla təkrarlanır, ən çoxuretryWindowMs(10 dəqiqə) ərzində;respondAsyncparametri vəjobs.resultmetodu.
Dəyişdirildi:
524və ya504sonrasıIdempotency-Keyartıq azad edilmir: iş bitmiş və ödənişi tutulmuş ola bilər. Eyni açarla təkrar sorğu ikinci ödəniş olmadan hazır nəticəni qaytarır, birinci çağırış hələ icra olunarkən isə409alır.
2026-10-03 - versiya 1.16
Dəyişdirildi:
429codedaşıyır:minute_limitvə yadaily_limit(açarın gündəlik limiti, 00:00 UTC-də sıfırlanır).- Agentlik açarı ilə yazılmış obyekt agentliyə məxsusdur; agentlik obyektlərinin və lidlərinin
object.*vəlead.*vebhukları agentliyin endpoint-lərinə də çatır. - Obyekt fotoları: kabinetdəki kimi, bütün növlər üçün 50-yə qədər.
- SDK 1.7.2: boş axın hissəsi artıq çat hadisəsini bölmür.
Düzəldildi:
PUT /objects/{kind}/{id}elanın moderasiya vəziyyətini,isSolddəyərini və dərcini saxlayır; əvvəllər onları sıfırlayırdı (adi redaktə aktiv elanı dərcdən çıxarırdı).GET /objectsartıq fəaliyyəti dayandırılmış sahiblərin obyektlərini siyahıya salmır; qonaqlardan gizlədilmiş kart id üzrə də göstərilmir.PATCH /leads/{id}: müqaviləsiz lidin göndəricisi kabinetdə olduğu kimi onun statusunu dəyişə bilər; dəyişiklik və arxiv lidin tarixçəsinə yazılır.
2026-10-03 - versiya 1.15
Dəyişdirildi:
PATCH /leads/{id}(status) vəDELETE /leads/{id}kabinet qaydalarına əməl edir: yekunlaşdırma, komissiyanın toplanması, aktiv müqavilə və ya razılaşma - səbəbicodedaxilində olan422.?expand=historyartıq xidməti metaməlumatları (tokenlər, digər istifadəçilərin id-ləri) daşımır.- Çatın pulsuz gündəlik limiti 00:00 UTC-yə qədər
Retry-Afteriləcode: free_daily_limitcavabı verir. GET /works:previewUrl,linkvəobject.photoUrlGET /artifacts/{path}üçün/files/...yollarıdır; son səhifədənextCursornullolur.- Lidin yazılması: naməlum sahələr atılır (rədd edilmir); xidmətin tətbiq etdiyi uzunluqlar spesifikasiyadadır;
pool: truelidi platformanın puluna verir. - SDK 1.7.1:
jobs.wait429bitənə qədər gözləyir;chat.streamhissələr arasında bölünmüş CRLF-i emal edir;artifact()signalqəbul edir.
Düzəldildi:
- Musiqi önizləməsi: sonu aşan
Range-416(əvvəllər404kimi cavablandırılırdı); fayl xidmətinin nasazlığı404deyil,502-dir. POST /uploadsdaxilində 15 MB-dan böyük fayl -413. Rədd edilmişstrictPhotoselanı yüklənə bilməyən fotoların adlarını göstərir (code: photo_fetch_failed).- Kontent paketinin imtinası
form.media.photossahəsini göstərir. Sandbox: yoxlama istənilən adlı ilk faylı götürür; icarə sətirləri və foto xidmətinin açarları rədd edilmir.
2026-10-03 - versiya 1.14
Dəyişdirildi:
- Eyni
Idempotency-Keyilə ekspres qiymətləndirmənin təkrarı indi tamamilə pulsuzdur: API çağırışı üçün də ödəniş tutulmur. GET /works:nextCursorolmayancursor-400(əvvəllər siyahı səssizcə yenidən başlayırdı).POST /webhooks/{id}/test: siyahıda olmayaneventType-400(əvvəllər ümumi test göndərirdi).- Swipe Match:
reasonCodeyalnız siyahıdakı səbəbləri qəbul edir, xidmətin həmişə tələb etdiyi kimi; lidinkinddəyəripoolola bilər. - SDK 1.7.0:
jobs.waitqırılmış sorğulamadan sağ çıxır;artifact()rangeqəbul edir;chat.streamCRLF axınlarını oxuyur və hər hadisəyə bir çağırış verir.
Düzəldildi:
- Musiqi önizləməsi:
bytes=-Nson N baytı qaytarır, sonu aşanRange-416. - Sorğu göndərilməzdən əvvəl bağlantının vaxtının bitməsi
Idempotency-Keyaçarını azad edir. - Sandbox: xidmətin oxuduğu istənilən sahə adı altında video fotoları, sətir kimi göndərilmiş icarə rəqəmləri, göstərilmiş ölçüdə flayer PNG-ləri.
2026-10-03 - versiya 1.13
Əlavə edildi:
GET /workskabinetin hər nəticə üçün göstərdiyini qaytarır:street,streetNumber,previewUrl,link,repeatIndex,errorvə elan (object).GET /chat/sessionsöz parametrlərini sənədləşdirir:limit,cursor,q,projectId,archivedOnly,sort.- Spesifikasiyada
Problem.titlerange_not_satisfiabledəyərini sadalayır; vebhuk siyahısırequestIddaşıyır. - SDK 1.6.1:
chat.listSessionssiyahı parametrlərini qəbul edir.
Dəyişdirildi:
- Spesifikasiya prodakşnın artıq tətbiq etdiyi limitləri göstərir: avatar
scriptText1200 simvola qədər, flayerformats3-ə qədər vəlayouts5-ə qədər, flayercontactssahələrinin uzunluqları, fotoseed2147483647-yə qədər və fotodatadaxilində naməlum açarların olmaması. - Ekspres qiymətləndirmə: şlüz yalnız ümumiyyətlə sahəsi və əmlak tipi olmayan sorğunu rədd edir;
landPlotAreadəyərinin sayılıb-sayılmamasına xidmət qərar verir (propertyTypevə yaapartmentTypedaxilində adı çəkilən torpaq da sayılır).
Düzəldildi:
- Sandbox fotoları prodakşndakı kimi rədd edir (25 MB-a qədər JPEG, PNG və ya WebP -
JOB_CREATE_FAILED; təmizləmədən kənar maska -MASK_NOT_SUPPORTED) və prodakşnın kəsdiyi və ya əvəz etdiyi şeyləri qəbul edir (video başlığı, səs səviyyəsi, son kadr və yekun ifadə parametrləri, landing səhifənin dili, 20-dən çox kontent fotosu, söz kimi icarəfurnished). Hesabat tapşırığı artıqrunningsonrasıpendinggöstərmir. - Rədd edilmiş endirmə yönləndirməsi vaxtın bitməsi əvəzinə bunu bildirir; fayldan uzun
Rangesuffiksi bütün faylı qaytarır. - SDK 1.6.1:
verifyWebhookSignatureNode 18-də işləyir.
2026-10-03 - versiya 1.12
Əlavə edildi:
- RFC 9457 problemi kimi
416 range_not_satisfiable(əvvəllər boş gövdə ilə gəlirdi). - Foto yaxşılaşdırmanın başladılmasında
priceMinor: çağırış üçün tutulan məbləğ, kabinetin göstərdiyi kimi. - SDK 1.6.0:
worksfrom/to,chat.historylimit/cursor,chat.sendMessagestyleqəbul edir.
Dəyişdirildi:
GET /match/leads: 50-dən çoxlimitvə ya 1000-dən çoxpage400cavabı verir (heç vaxt kəsilmirdi).POST /match/leads/{id}/events: başqa formatlıIdempotency-Keysəssizcə atılmaq əvəzinə400olur.- Flayerin rədd etdiyi sahə sahənin adını göstərən
400 validationolur (əvvəllər422idi). - Ödənişi eyni
Idempotency-Keyaltında hələ rezerv edilən çağırış -409 idempotency_conflict(əvvəllər422idi). - Ekspres qiymətləndirmə:
landPlotAreaxidmətdə olduğu kimi yalnızlandüçün sahə kimi sayılır. - Vaxtın bitməsi, sıfırlanmış bağlantı və ya cavabın ortasında bağlanmış soket
Idempotency-Keyaçarını tutulmuş saxlayır; yalnız xidmətə heç vaxt çatmamış sorğu onu azad edir. - SDK 1.6.0: yükləmə
503sonrası heç vaxt təkrarlanmır; hər fasilədən sonra abort dinləyicisi silinir.
Düzəldildi:
- PDF və landing səhifə imtinaları səbəbini daşıyır:
INSUFFICIENT_FUNDSvə yaQUOTA_EXCEEDEDilə402(əvvəllərcodeolmadan422idi). - Sandbox prodakşnın rədd etdiyini dəqiq rədd edir: yüklənən faylların tipi və ölçüsü; mətnlər rədd edilmək əvəzinə kəsilir; naməlum video
length,aspectvəlanguagestandart dəyərə qayıdır; flayer kodları böyük-kiçik hərfə həssas deyil;typeolmadan qaralama. Vəsait çatışmazlığı simulyasiyası prodakşnın göndərdiyi kod olanINSUFFICIENT_FUNDScavabı verir. limitvəpagediapazona şlüzün özü tərəfindən salınır (GET /chat/history?limit=500400cavabı verirdi;limit=01 əvəzinə 20 verirdi).
2026-10-03 - versiya 1.11
Əlavə edildi:
- Tapşırıq nəticələri kabinetin göstərdiyi sahələri daşıyır: kontent paketi, mətn və video -
progress,masterProfile(mətnlərin və səsləndirmənin əsaslandığı süjet planı) və uğursuz tapşırıq üçünerror; foto -metadata.error; mərtəbə planı -rooms[].stable,rooms[].placement,sourceFileId. - Brauzerlər (CORS)
RateLimit-*,Retry-After,Grem-Sandbox,X-Request-IdvəContent-Rangebaşlıqlarını oxuya bilir.
Dəyişdirildi:
- Vebhuklar: test açarı yalnız sandbox endpoint-lərini yaradır və idarə edir; onlar yalnız sandbox tapşırıqlarının hadisələrini alır, canlı endpoint-lər isə onları heç vaxt almır.
- Diapazondan kənar
limitvəpage400əvəzinə diapazona salınır;GET /objectsdaxilindəkindböyük-kiçik hərfə həssas deyil;roomskəsr ola bilər. Idempotency-KeyAPI açarına, metoda və faktiki yola aiddir (POST /objects/propertyvəPOST /objects/rentalfərqli əməliyyatlardır). Vaxt bitdikdən sonra elan və lid yaratma sorğuları, alətlərdə olduğu kimi, açarı 15 dəqiqə saxlayır; xidmətə heç vaxt çatmamış sorğu onu azad edir.text/generate:customDirection500 simvola qədər kəsilir.- SDK 1.5.1: yazma əməliyyatında
503yalnızIdempotency-Keyilə təkrarlanır; 30 saniyədən uzunRetry-Aftergözlənilmir;maxRetriesən çoxu 10-dur; sizinAbortSignalfasiləni ləğv edir; mesaj id-ləri Node 18-də işləyir.
Düzəldildi:
- Sandbox prodakşn kimi işləyir:
multipartsahələrinin, kateqoriya üzrə hesabat sahələrinin, ev istiliyi dəyərlərinin, kommersiyaapartmentTypevə komplekslərin yoxlanması; fayllar yalnız tamamlanmış tapşırıqlar üçün, alətin öz yolunda və məlum artefakt id-ləri ilə;Grem-Sandboxaçar yoxlamasından əvvəl verilən cavablarda da;Grem-Simulateböyük-kiçik hərfə həssas deyil. - Açar olmadan etibarsız sorğu parametrləri əvvəlcə
401cavabı verir. - Agent səviyyəli agentlik açarı artıq agentlik səviyyəli açarla başladılmış tapşırıqları oxumur.
- Əvvəllər başqa portda saxlanmış vebhuk endpoint-ləri çatdırılmaları almağa davam edir.
- Təmin edilə bilməyən
Range404əvəzinə416cavabı verir; 40 MB-a qədər hesabat yoxlaması sənədi qəbul edilir.
2026-10-03 - versiya 1.10
Əlavə edildi:
conflictxəta kodu (409): resurs əməliyyata imkan verməyən vəziyyətdədir (Xətalar).POST /video/createdaxilində videonun yekun ifadə sahələri:ctaMode,ctaIntent,ctaText,ctaMarket;GET /video/endingsvariantlarıintentvətextdaşıyır.GET /works:fromvətofiltrləri.- SDK 1.5.0:
maxRetriesparametri -429və503Retry-Aftersonrası təkrarlanır.
Dəyişdirildi:
- Sorğu parametrləri yoxlanılır: etibarsız dəyərli məlum parametr sahənin adını göstərən
400 validationolur. - Vebhuklar: yalnız 443 portunda
https, URL-də giriş məlumatları olmadan; 11-ci ünvan -422; agentlik vebhukları yalnız agentlik səviyyəli açarla idarə olunur. Idempotency-KeyAPI açarına və əməliyyata aiddir; alətin vaxtı bitdikdən sonra açar 15 dəqiqə rezervdə qalır.- Pul imtinaları (kvota, borc, ədalətli istifadə, balans)
codeilə402 insufficient_fundsolur. - Agent səviyyəli agentlik açarı yalnız öz tapşırıqlarını və fayllarını görür.
- Faylların endirilməsi sorğu limitinə daxil edilir.
Düzəldildi:
- Hər xəta, o cümlədən çox böyük və ya səhv formalaşmış gövdə, RFC 9457
application/problem+jsonkimi gəlir; limiti aşan gövdə -413 payload_too_large. - Videonun
endingsahəsi heç vaxt oxunmurdu;ctaIntentvə yactaTextistifadə edin. - SDK: canlı açarla
simulateçağırışı icra etmək əvəzinə xəta atır.
2026-10-03 - versiyalar 1.8-1.9
Əlavə edildi:
- Analoq elanlar: ekspres qiymətləndirmədə
estimate.analogs, tam hesabatdaanalogs, icarə qiymətləndirməsindəcomps- kabinetdə və PDF-də olduğu kimi. - Tamamlanmış tapşırıqların sahələri tam təsvir edilib: hesabat göstəriciləri real adları ilə (
potPrice,priceRangeLow,priceRangeHigh, …), yoxlama, mərtəbə planı, foto, flayer, qaralama. - SDK 1.4.0:
Analogtipi.
Dəyişdirildi:
- Alət cavabları yalnız sənədləşdirilmiş sahələri daşıyır; əvvəllər sızan daxili sahələr artıq qaytarılmır.
GET /tools/statusəlçatan olmadığını bildirdiyi alət hər hansı ödəniş tutulmazdan əvvəl503 service_unavailablecavabı verir (əvvəllər bu, yalnız kontent paketi, mətnlər və video üçün keçərli idi).- Qiymətləndirmə yoxlamasının təsdiq cavabı yalnız tapşırıq sahələrini (
jobId,state,status) daşıyır; köhnəlmiş_idorada artıq qaytarılmır.
Düzəldildi:
- Avatar video:
artifactsendirmə URL-i üçün lazım olan id-ləri sadalayır. - İcarə üçün
checkIn/checkOutgünün saatları kimi sənədləşdirilib.
2026-10-02 - versiya 1.7
Əlavə edildi:
- Sandbox: test açarları (
gsk_test) alətləri ödənişsiz simulyasiya edir;Grem-Simulatebaşlığı nəticəni seçir. - Ekspres qiymətləndirmədə
estimate.confidenceScore.
Dəyişdirildi:
- Aləti işə salan çağırışlar 60 saniyə əvəzinə 5 dəqiqəyə qədər gözləyir.
- Eyni
Idempotency-Keyilə təkrarlanan ekspres qiymətləndirmə, vaxt bitdikdən sonra da, ikinci ödəniş olmadan hazır nəticəni qaytarır.
Düzəldildi:
- Ekspres qiymətləndirmənin
estimate.confidencedəyəri həmişənullidi. - Mərtəbə planı cavabları artıq daxili sahələr daşımır.
kindolmadanGET /objects, həmçinin elanlar və lidlər üçün imtinalar indi səbəbidetaildaxilində izah edir.
2026-10-02 - versiya 1.6
Dəyişdirildi:
- Hər tapşırıq cavabı eyni
jobIdsahəsini daşıyır. Alətlərə məxsusid,_id,contentGenJobIdadları hələ də qaytarılır və köhnəlmiş sayılır. - SDK 1.2.0:
Job.jobIdhəmişə mövcuddur.
2026-10-02 - versiyalar 1.2-1.5
Əlavə edildi:
GET /voices,GET /avatar/avatars,GET /video/music,GET /video/endings- alətlər üçün id-lər (Arayış məlumatları).GET /tools/status- alətlərin əlçatanlığı;GET /works- işlərin tarixçəsi.POST /flyer/create- şəxsi flayer, scopetools:flyer.POST /valuation/review/jobs/{id}/confirm- hesabat yoxlaması məlumatlarının təsdiqi.- Hər tapşırıq cavabında
statesahəsi. - Xətalarda -
codevəerrorssahələri,forbidden,payload_too_large,service_unavailablekodları. - API təsvirində - hər alət üçün tam sorğu və cavab sxemləri, hər növ üzrə elan yazmanın tam müqaviləsi, hər əməliyyatın ödəniş sinfi (
x-grem-billing), scope-ların və hadisələrin siyahısı. scope(elanlar) vəpool(lidlər) parametrləri sənədləşdirilib.
Dəyişdirildi:
- Çatışmayan məlumatlara görə imtina (məsələn, təsvirsiz və ya şəhərsiz mətnlər) indi səbəb və kodla
422 business_ruleolur. Əvvəllər502 provider_erroridi. - Resurs icazələrinə görə imtina indi səbəblə
403 forbiddenolur. Əvvəllər500idi. - Alətlər üçün test vebhuk çatdırılması realı ilə eyni formadadır:
{ jobId, status, state }.
Düzəldildi:
- Agentlik açarları bütün alətlərlə, çatla və faylların endirilməsi ilə işləyir.
- Hesabatın yoxlanması və mərtəbə planı: tapşırığın statusu cavabdakı id üzrə əlçatandır, vebhuklar gəlir.
- Kontent paketi, mətn və video fayllarının endirilməsi - yalnız tapşırığın sahibi üçün.