OpenAI/cancelVectorStoreFileBatch

Online calls unavailable · details below

OpenAIOpenAI API

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

Manage cancel Vector Store File Batch.

Contract-preserving POST Endpoint for cancel Vector Store File Batch in the OpenAI API. Model and resource-specific values are supplied by the caller at runtime.

All 288 OpenAI Platform REST endpoints from a fixed MIT-licensed official revision, including typed SSE streaming and Realtime call management. Hub provides documentation and an independent SDK/CLI, but never proxies model, account, or usage data; callers connect directly with local API keys.

Request

operationId
cancelVectorStoreFileBatch
Server
https://api.openai.com/v1
Authentication
ApiKeyAuth, AdminApiKeyAuth

Request parameters

vector_store_id

pathstringrequired

vector store id value in the OpenAI API contract.

batch_id

pathstringrequired

batch id value in the OpenAI API contract.

Responses

200

VectorStoreFileBatchObjectapplication/json

Successful supplier response.

Properties: created_atfile_countsidobjectstatusvector_store_id

429

ErrorResponseapplication/json

Supplier response with HTTP status 429.

Properties: error

{
  "created_at": 0,
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "object": "vector_store.files_batch",
  "status": "in_progress"
}