Materials
Create material and wait for processing to complete
Creates a material and waits for processing to finish before returning. Useful for synchronous API usage.
OpenAPI specificationPOST
/api/v1/materials/upload-and-processAuthentication
x-api-key
Request
curl --globoff --request POST \
--url 'https://api.example.com/api/v1/materials/upload-and-process' \
--header 'x-api-key: <API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Chapter 1 - Introduction",
"content": "<content>"
}'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.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Request body schema or example
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Chapter 1 - Introduction",
"description": "Name of the material"
},
"content": {
"description": "Content details",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"pdf",
"video",
"audio",
"url"
],
"description": "Type of content"
},
"text": {
"type": "string",
"description": "Text content (for text type)"
},
"url": {
"type": "string",
"description": "URL to the content (for url type)"
},
"sourceUrl": {
"type": "string",
"description": "URL to fetch content from"
}
},
"required": [
"type"
]
}
]
},
"folderId": {
"type": "string",
"description": "Folder ID to place the material in"
},
"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"
]
}
},
"timeoutMs": {
"type": "number",
"default": 300000,
"description": "Maximum time to wait for processing in milliseconds (default: 5 minutes)"
},
"pollIntervalMs": {
"type": "number",
"default": 2000,
"description": "Polling interval in milliseconds (default: 2 seconds)"
}
},
"required": [
"name",
"content"
]
}Responses
201Material created 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"
]
}