JIjina
Batch Embeddings

Cancel a batch job

Changed on

Cancel a pending or processing batch job.

delete/v1/batch/{batch_id}

Request

Path parameters

batch_idstring required

Response

Successful Response

batch_idstring required

Unique identifier for the batch job.

status'pending' | 'processing' | 'completed' | 'failed' | 'expired' | 'cancelled' required

Current status of the batch job.

modelstring required

The model used for embedding.

created_atstring required

ISO 8601 timestamp when job was created.

completed_atstring nullable

ISO 8601 timestamp when job completed (if finished).

expires_atstring nullable

ISO 8601 timestamp when output URL expires (created_at + 24h).

output_urlstring nullable

Signed URL to download output JSONL (24h expiry).

error_file_urlstring nullable

URL to download error JSONL for failed lines.

errorstring nullable

Error message if job failed.

Example response

{
  "batch_id": "batch_abc123",
  "completed_at": "2024-01-15T10:35:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "expires_at": "2024-01-16T10:30:00Z",
  "model": "jina-embeddings-v5-text-small",
  "output_url": "https://storage.googleapis.com/...",
  "stats": {
    "completed": 998,
    "failed": 2,
    "total": 1000
  },
  "status": "completed"
}

Changes

  • e1c9fccc2a1aRevision changes
    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 504

    • breaking

      response property errors list-of-types was widened by adding types null to media type application/json of response 422

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 504

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

  • a92cc1f233ebRevision changes
    • info

      endpoint added