Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Files
Upload a file
Uploads a file to the specified file upload ID placeholder
POST
/
public
/
apps
/
files
/
uploads
/
{file_upload_id}
{
"id": "<string>",
"file_id": "<string>",
"file_filename": "document.pdf",
"file_size": 1024,
"file_mimetype": "application/pdf",
"file_url": "<string>",
"file_format": "DOCUMENT",
"file_status": "PROCESSED",
"file_status_message": "<string>",
"document": {
"filename": "<string>",
"filetype": "<string>",
"contents": [
{
"id": 123,
"type": "TITLE",
"content": "<string>",
"content_as_html": "<string>",
"page": 123,
"parent": 123
}
],
"images": [
{
"id": "<string>",
"file_id": "<string>",
"image_url": "<string>",
"type": "<string>",
"page": 123,
"height": 123,
"width": 123
}
],
"extracted_pages": "<string>",
"time": 123
},
"document_extract_contents": true,
"document_extract_images": true,
"document_extract_pages": true,
"document_pages": [
1,
2,
3
],
"document_progress": 123,
"storage": "PERSISTENT",
"created_at": "2023-12-25"
}
Path Parameters
The ID of the file upload
Body
The file to upload
The body is of type object
.
Response
200 - application/json
Detailed information about a file
Was this page helpful?
{
"id": "<string>",
"file_id": "<string>",
"file_filename": "document.pdf",
"file_size": 1024,
"file_mimetype": "application/pdf",
"file_url": "<string>",
"file_format": "DOCUMENT",
"file_status": "PROCESSED",
"file_status_message": "<string>",
"document": {
"filename": "<string>",
"filetype": "<string>",
"contents": [
{
"id": 123,
"type": "TITLE",
"content": "<string>",
"content_as_html": "<string>",
"page": 123,
"parent": 123
}
],
"images": [
{
"id": "<string>",
"file_id": "<string>",
"image_url": "<string>",
"type": "<string>",
"page": 123,
"height": 123,
"width": 123
}
],
"extracted_pages": "<string>",
"time": 123
},
"document_extract_contents": true,
"document_extract_images": true,
"document_extract_pages": true,
"document_pages": [
1,
2,
3
],
"document_progress": 123,
"storage": "PERSISTENT",
"created_at": "2023-12-25"
}