Bazı araçlar hemen (eşzamanlı) yanıt verir; diğerleri bir iş başlatır ve arka planda bitirir. Bu sayfa ikinci durumu anlatır: bir işin bittiğini nasıl anlarsınız ve sonucu nasıl alırsınız.
Oluşturma yanıtı
Eşzamansız bir araç 202 ile yanıt verir:
{ "jobId": "...", "status": "...", "state": "pending", "requestId": "req_..." }
state alanı tüm araçlar için aynıdır; ona güvenin:
| Değer | Anlamı |
|---|---|
pending | kabul edildi, henüz başlamadı |
running | sürüyor |
action_required | sizden bir işlem bekliyor (rapor incelemesi: çıkarılan verileri onaylayın) |
completed | bitti |
partial | kısmen bitti: bazı dosyalar başarısız oldu (içerik paketinde olabilir) |
failed | başarısız oldu |
status aracın ham durumudur (DONE, processing, need_confirm vb.). Uyumluluk için korunur; yeni entegrasyonları state üzerine kurun.
İş kimliği
Her aracın her iş yanıtı jobId alanını içerir: oluşturmada, durumda ve onaydan sonra. Durumu bununla sorgulayın.
Sürüm 1.6.0'dan önce araçlar kimliği farklı adlarla döndürüyordu (id, _id, contentGenJobId). Bu alanlar mevcut entegrasyonlar için korunur ancak kullanımdan kaldırılmıştır: jobId kullanın.
Durum sorgulama
Durum GET /<araç yolu>/jobs/{id} adresindedir:
| Araç | Durum |
|---|---|
| Tam değerleme raporu | GET /valuation/report/jobs/{id} |
| Rapor incelemesi | GET /valuation/review/jobs/{id} |
| İçerik paketi | GET /content/generate/jobs/{id} |
| Metinler | GET /text/generate/jobs/{id} |
| Video | GET /video/create/jobs/{id} |
| Avatar | GET /avatar/video/jobs/{id} |
| Fotoğraf | GET /photo/enhance/jobs/{id} |
| Kat planı | GET /floorplan/create/jobs/{id} |
GET /pdf/create/jobs/{id} |
- Sorgulama ücretsizdir ve API çağrısı sayılmaz, ancak istek sıklığı limitine dahil edilir. 3 ila 5 saniyede bir yeterlidir.
- İşi yalnızca onu oluşturan anahtarın hesabı görebilir. Başkasına ait veya bilinmeyen bir kimlik aynı
404yanıtını alır. - Bir ajansın temsilciye bağlı anahtarı yalnızca kendi başlattığı işleri görür; ajans genelindeki anahtar ajansın tüm işlerini görür.
- Bir işin durumu oluşturulduktan sonra 7 gün sorgulanabilir. Sonrasında
GET .../jobs/{id}404döndürür ve içerik paketi, metin ve video dosyaları artık API üzerinden indirilemez. - Durum yanıtı aynı
statusvestatealanlarını, hazır olduğunda da aracın sonucunu taşır. Başarısız bir içerik paketi, metin veya video işierror, bir fotoğraf işimetadata.errortaşır: neden, genel bir metin olarak.
Kat planı ve rapor incelemesi belgeyi hemen işler: 202 yanıtı zaten son durumu (completed, failed veya action_required) içerir, bu yüzden sorgulama isteğe bağlıdır.
Bir iş sizi beklediğinde
Belgeyi okuduktan sonra rapor incelemesi (Değerleme) action_required durumunda durur ve çıkarılan verileri extracted içinde döndürür. Kontrol edip onaylayın:
curl -X POST https://developers.grem.capital/api/v1/valuation/review/jobs/JOB_ID/confirm \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{}'
Boş gövde «her şey doğru» anlamına gelir. Bir değeri düzeltmek için yalnızca değişen alanları, yanıttakiyle aynı adlarla extracted içinde gönderin (iç içe subject nesnesi bir düzey derinlikte birleştirilir). Ardından iş running durumuna geçer ve sonuç her zamanki gibi gelir.
Sorgulama yerine webhook'lar
Her eşzamansız araç bir <araç>.completed veya <araç>.failed olayı gönderir (içerik paketi ayrıca content.partial gönderir). Abonelik ve imza doğrulama: Webhook'lar.
- Olay genellikle iş bittikten sonraki bir dakika içinde gelir.
- Bir iş yalnızca, olayına ait abonelik iş oluşturulduğunda zaten varsa izlenir. İşi başlatmadan önce abone olun, sonra değil.
- Bir iş 30 dakika içinde bitmezse
reason: "timeout"ile.failedgelir. İşin kendisi yine de bitebilir: sorgulama gerçek durumunu gösterir.
Hazır dosyalar
Dosyalar aynı anahtarla GET /artifacts/{path} üzerinden indirilir (tools:artifacts kapsamı). Ücretsizdir, Range desteklenir. {path} şunlardan biridir:
| Ne | Yol |
|---|---|
| İçerik paketi, metin veya video dosyası | v1/ai/assistant/announcement/jobs/{jobId}/artifacts/{artifactId}/download |
| Avatar videosu | v1/ai/assistant/avatar/jobs/{jobId}/artifacts/{artifactId}/download |
| PDF sunum | v1/ai/pdf-generator/files/{id}/download |
| İyileştirilmiş fotoğraf | v1/ai/photo-enhancement/jobs/{jobId}/download/{variant} |
| Tam değerleme raporu PDF'i | v1/ai/appraisal/reports/{id}/pdf |
| Kira tahmini PDF'i | v1/ai/appraisal/rent/{id}/pdf |
| İnceleme raporu | v1/ai/appraisal/reviews/{id}/report.pdf veya report.docx |
| Kat planı raporu | v1/ai/floor-plan/jobs/{id}/report.pdf |
| Broşür dosyası | v1/ai/flyer/file/{name} |
| Video için parça (dinleme) | v1/ai/video-generator/music/{trackId} |
| Normal dosya | araç yanıtındaki /files/... yolu |
İçerik paketi dosyalarının kimlikleri iş durumunun artifacts alanındadır. İçerik paketi, metin ve video dosyaları yalnızca aynı hesap tarafından API üzerinden oluşturulan işler için, 7 gün boyunca kullanılabilir.
curl -L -o video.mp4 \
"https://developers.grem.capital/api/v1/artifacts/v1/ai/assistant/announcement/jobs/JOB_ID/artifacts/ARTIFACT_ID/download" \
-H "Authorization: Bearer gsk_live_xxx"
PDF sunumun ayrıca bir link alanı vardır: belgenin doğrudan adresi.
İlgili makaleler
- API üzerinden araçlar: hangi araçlar eşzamanlı, hangileri eşzamansız.
- Webhook'lar: sonuçları sorgulamadan alın.
- Dosyalar: ilanlar ve araçlar için görsel yükleme.