Mistral AI · Schema

BatchJob

Properties

Name Type Description
id string Unique identifier for the batch job
object string
input_files array Input file IDs
endpoint string The API endpoint used
model string The model used
output_file stringnull Output file ID when job completes
error_file stringnull Error file ID if there were errors
status string Current status of the batch job
created_at integer Unix timestamp when the job was created
started_at integernull Unix timestamp when the job started processing
completed_at integernull Unix timestamp when the job completed
metadata object
total_requests integer Total number of requests in the batch
completed_requests integer Number of completed requests
succeeded_requests integer Number of successful requests
failed_requests integer Number of failed requests
View JSON Schema on GitHub

JSON Schema

mistral-batchjob-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BatchJob",
  "title": "BatchJob",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the batch job"
    },
    "object": {
      "type": "string",
      "enum": [
        "batch"
      ]
    },
    "input_files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Input file IDs"
    },
    "endpoint": {
      "type": "string",
      "description": "The API endpoint used"
    },
    "model": {
      "type": "string",
      "description": "The model used"
    },
    "output_file": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "Output file ID when job completes"
    },
    "error_file": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "Error file ID if there were errors"
    },
    "status": {
      "type": "string",
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCESS",
        "FAILED",
        "TIMEOUT_EXCEEDED",
        "CANCELLATION_REQUESTED",
        "CANCELLED"
      ],
      "description": "Current status of the batch job"
    },
    "created_at": {
      "type": "integer",
      "description": "Unix timestamp when the job was created"
    },
    "started_at": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Unix timestamp when the job started processing"
    },
    "completed_at": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Unix timestamp when the job completed"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "total_requests": {
      "type": "integer",
      "description": "Total number of requests in the batch"
    },
    "completed_requests": {
      "type": "integer",
      "description": "Number of completed requests"
    },
    "succeeded_requests": {
      "type": "integer",
      "description": "Number of successful requests"
    },
    "failed_requests": {
      "type": "integer",
      "description": "Number of failed requests"
    }
  }
}