BatchProcessResponse
Response from batch processing request
Properties
| Property | Type | Required | Description |
|---|---|---|---|
status | string | ✅ Yes | Status: 'accepted', 'completed', 'error' |
batch_id | string | ✅ Yes | Unique batch processing ID |
total_files | integer | ✅ Yes | Number of files queued for processing |
estimated_time_minutes | object | ❌ No | Estimated completion time |
status_url | object | ❌ No | URL to check processing status |
error | object | ❌ No | Error message if status is 'error' |
Example
{
"status": "example",
"batch_id": "example",
"total_files": 0,
"estimated_time_minutes": {},
"status_url": {},
"error": {}
}Used In
Code Examples
TypeScript
interface BatchProcessResponse {
status: string;
batch_id: string;
total_files: number;
estimated_time_minutes?: any;
status_url?: any;
error?: any;
}
// Usage example
const data: BatchProcessResponse = {
"status": "example",
"batch_id": "example",
"total_files": 0,
"estimated_time_minutes": {},
"status_url": {},
"error": {}
};Python
from data_layer.schemas import BatchProcessResponse
# Create instance
data = BatchProcessResponse(
# 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, "estimated_time_minutes": {}, "status_url": {}, "error": {} }'Validation Rules
Required Fields: status, batch_id, total_files
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.