Materials
Upload material file and wait for processing to complete
Uploads a file and waits for processing to finish before returning. Useful for synchronous API usage.
OpenAPI specificationPOST
/api/v1/materials/upload/file-and-processAuthentication
x-api-key
Request
curl --globoff --request POST \
--url 'https://api.example.com/api/v1/materials/upload/file-and-process' \
--header 'x-api-key: <API_KEY>'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Replace https://api.example.com with the API server URL.
Add the required request body using one of these media types: multipart/form-data. This template does not encode that body format.
Request body schema or example
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"name": {
"type": "string",
"description": "Material name"
},
"folderId": {
"type": "string",
"description": "Folder ID (optional). If folderPath is provided, folderId will be ignored."
},
"folderPath": {
"type": "string",
"description": "Relative folder path (e.g., \"folder1/folder2\"). Folders will be created if they don't exist. The filename can be included (e.g., \"folder1/folder2/image1.png\") and will be extracted automatically."
},
"timeoutMs": {
"type": "number",
"description": "Processing timeout in milliseconds (default: 300000 - 5 minutes)"
},
"pollIntervalMs": {
"type": "number",
"description": "Polling interval in milliseconds (default: 2000)"
},
"extractImages": {
"type": "string",
"description": "Whether to extract images from files (true/false, default: true)",
"default": "true"
}
},
"required": [
"file",
"name"
]
}Responses
201Material uploaded and processed successfully
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Material ID"
},
"name": {
"type": "string",
"description": "Material name"
},
"organizationId": {
"type": "string",
"description": "Organization ID"
},
"folderId": {
"type": "string",
"description": "Folder ID",
"nullable": true
},
"contentType": {
"type": "string",
"description": "Content type",
"enum": [
"text",
"pdf",
"video",
"audio",
"image",
"epub"
]
},
"content": {
"type": "object",
"description": "Material content",
"properties": {
"text": {
"type": "string"
},
"url": {
"type": "string"
},
"s3Key": {
"type": "string"
},
"s3Url": {
"type": "string"
},
"filename": {
"type": "string"
},
"fileSize": {
"type": "number"
},
"mimeType": {
"type": "string"
}
}
},
"metadata": {
"type": "object",
"description": "Material metadata"
},
"status": {
"type": "string",
"description": "Material status",
"enum": [
"active",
"processing",
"pending_upload",
"error",
"deleted"
]
},
"usage": {
"type": "object",
"description": "Usage information"
},
"references": {
"description": "References that this material cites",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Understanding Photosynthesis",
"description": "Reference title"
},
"url": {
"type": "string",
"example": "https://example.com/article",
"description": "Reference URL"
}
},
"required": [
"title"
]
}
},
"createdAt": {
"format": "date-time",
"type": "string",
"description": "Creation timestamp"
},
"updatedAt": {
"format": "date-time",
"type": "string",
"description": "Last update timestamp"
}
},
"required": [
"_id",
"name",
"organizationId",
"folderId",
"contentType",
"content",
"status",
"createdAt",
"updatedAt"
]
}