Dosyalar ve toplu işler

Mesaj Toplu İşlemini (Batch) Getir

Bir Mesaj Toplu İşleminin durumunu ve istek sayılarını getirir.

GET
/v1/messages/batches/{message_batch_id}

Genel Bakış

Kuruluşunuz tarafından oluşturulan bir Mesaj Toplu İşleminin durumunu, istek sayılarını ve zaman damgalarını döndürür. processing_status değeri ended olana kadar bu uç noktayı sorgulayın, ardından sonuçları alın.

Notlar

  • processing_status değeri in_progress, canceling veya ended olabilir.
  • results_url, toplu işlem sona erene kadar null değerindedir.
  • Mevcut olmayan veya silinmiş bir toplu işlem 404 hatası döndürür. Henüz okunmaya hazır olmayan bir toplu işlem 409 hatası döndürebilir; daha sonra tekrar deneyin.

Örnek

İstek

cURL
curl -X GET "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

Yanıt örneği

Yanıt

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch",
  "processing_status": "ended",
  "request_counts": {
    "processing": 0,
    "succeeded": 2,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": "2026-11-01T10:20:00Z",
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": null,
  "archived_at": null,
  "results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
}

Önemli alanlar

processing_statusstring
in_progress, canceling veya ended.
request_countsobject
processing, succeeded, errored, canceled veya expired durumundaki isteklerin sayısı.
ended_atstring|null
İşlemin sona erdiği zaman veya null.
cancel_initiated_atstring|null
İptal isteğinin kabul edildiği zaman veya null.
results_urlstring|null
Sonuçların URL'si veya null.

Yetkilendirme

BearerAuth
AuthorizationBearer <token>

API Anahtarı kimlik doğrulaması. API anahtarlarını Dashboard > API > API Keys bölümünden oluşturun veya yönetin.

Konum: header

Yol parametreleri

message_batch_id*string

Mesaj toplu iş tanımlayıcısı

Yanıt

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json