BatchStatusResponse

Response with batch processing status

Properties

Property	Type	Required	Description
`status`	`string`	✅ Yes	Status: 'queued', 'processing', 'completed', 'failed'
`batch_id`	`string`	✅ Yes	Batch processing ID
`total_files`	`integer`	✅ Yes	Total files in batch
`processed`	`integer`	✅ Yes	Number of files processed
`successful`	`integer`	✅ Yes	Number successfully processed
`failed`	`integer`	✅ Yes	Number failed
`progress_percentage`	`number`	✅ Yes	Overall progress (0-100)
`results`	`object`	❌ No	Processing results for each file
`output_directory`	`object`	❌ No	Directory containing generated contracts
`error`	`object`	❌ No	Error message if status is 'failed'

Example

{
  "status": "example",
  "batch_id": "example",
  "total_files": 0,
  "processed": 0,
  "successful": 0,
  "failed": 0,
  "progress_percentage": 0,
  "results": {},
  "output_directory": {},
  "error": {}
}

Used In

GET /api/batch/status/{batch_id}

Code Examples

TypeScript

interface BatchStatusResponse {
  status: string;
  batch_id: string;
  total_files: number;
  processed: number;
  successful: number;
  failed: number;
  progress_percentage: number;
  results?: any;
  output_directory?: any;
  error?: any;
}
 
// Usage example
const data: BatchStatusResponse = {
  "status": "example",
  "batch_id": "example",
  "total_files": 0,
  "processed": 0,
  "successful": 0,
  "failed": 0,
  "progress_percentage": 0,
  "results": {},
  "output_directory": {},
  "error": {}
};

Python

from data_layer.schemas import BatchStatusResponse
 
# Create instance
data = BatchStatusResponse(
    # Add your field values here
)

cURL

curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{   "status": "example",   "batch_id": "example",   "total_files": 0,   "processed": 0,   "successful": 0,   "failed": 0,   "progress_percentage": 0,   "results": {},   "output_directory": {},   "error": {} }'

Validation Rules

Required Fields: status, batch_id, total_files, processed, successful, failed, progress_percentage

Additional Information

Type: object
Source: Generated from Pydantic models in data_layer/schemas/
Auto-validated: All fields are validated by FastAPI

This documentation is auto-generated from the OpenAPI specification.

BatchProcessResponse BettingOpportunitiesResponse