Cancel vector store file batch

POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

cURL

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "object": "vector_store.files_batch",
  "created_at": 123,
  "vector_store_id": "<string>",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 123,
    "completed": 123,
    "failed": 123,
    "cancelled": 123,
    "total": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vector_store_id · string · required

batch_id · string · required

Response

200 - application/json

id · string · required

object · enum<string> · required

Available options: vector_store.files_batch

created_at · integer · required

vector_store_id · string · required

status · enum<string> · required

Available options: in_progress, completed, cancelled, failed

file_counts · object · required

Show child attributes