DocumentUploadResponse
Document upload response model
Properties
| Property | Type | Required | Description |
|---|---|---|---|
success | boolean | ✅ Yes | - |
document_id | object | ❌ No | - |
filename | string | ✅ Yes | - |
status | string | ✅ Yes | - |
message | string | ✅ Yes | - |
gcs_uri | object | ❌ No | - |
rag_import_started | boolean | ❌ No | - |
timestamp | string | ✅ Yes | - |
Example
{
"success": false,
"document_id": {},
"filename": "example",
"status": "example",
"message": "example",
"gcs_uri": {},
"rag_import_started": false,
"timestamp": "example"
}Used In
Code Examples
TypeScript
interface DocumentUploadResponse {
success: boolean;
document_id?: any;
filename: string;
status: string;
message: string;
gcs_uri?: any;
rag_import_started?: boolean;
timestamp: string;
}
// Usage example
const data: DocumentUploadResponse = {
"success": false,
"document_id": {},
"filename": "example",
"status": "example",
"message": "example",
"gcs_uri": {},
"rag_import_started": false,
"timestamp": "example"
};Python
from data_layer.schemas import DocumentUploadResponse
# Create instance
data = DocumentUploadResponse(
# 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 '{ "success": false, "document_id": {}, "filename": "example", "status": "example", "message": "example", "gcs_uri": {}, "rag_import_started": false, "timestamp": "example" }'Validation Rules
Required Fields: success, filename, status, message, timestamp
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.