Dosyalar ve toplu işler

Mesaj Toplu İşlemini İptal Et

Hâlâ işlenmekte olan bir Mesaj Toplu İşlemini iptal eder.

POST
/v1/messages/batches/{message_batch_id}/cancel

Genel Bakış

Hâlâ işlenmekte olan bir Mesaj Toplu İşleminin iptalini talep edin. Yanıt, mevcut durumu gösterir. processing_status genellikle canceling değerindedir ve hâlihazırda çalışmakta olan istekler tamamlanmaya devam edebilir. Zaten sona ermiş bir toplu işlem, değiştirilmeden döndürülür.

Notlar

  • İptal işleminden sonra, processing_status değeri ended olana kadar toplu işlemi sorgulayın. Henüz başlamamış olan istekler canceled olarak sonuçlanır.
  • Mevcut olmayan veya silinmiş bir toplu işlem 404 hatası döndürür. Henüz değiştirilmeye hazır olmayan bir toplu işlem 409 hatası döndürür; daha sonra tekrar deneyin.
  • İptal işlemi toplu işlemi silmez. Kaldırmak için, işlem sona erdikten sonra silme işlemini gerçekleştirin.

Örnek

İstek

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -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": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

Önemli alanlar

processing_statusstring
İptal işlemi devam ederken canceling, tamamlandığında ise ended değerini alır. Her iptal isteğinin canceling döndüreceğini varsaymayın.
cancel_initiated_atstring|null
İptal isteğinin kabul edildiği zaman 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