Add document action
POST/documents/:documentId/actions
Add one or more actions to a document; this appends actions and does not replace previous actions
Each action type supports a different set of parameters as shown in the table below:
Action Parameters
| ActionType | Parameter | Description | Example |
|---|---|---|---|
| OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES, QUERIES (requires 'ocrTextractQueries') |
| OCR | ocrTextractQueries | Required for "QUERIES", questions to ask Textract | |
| OCR | ocrEngine | Ocr Engine to use | tesseract or textract |
| OCR | ocrOutputType | Convert OCR result to an Output format (textract table only) | true |
| OCR | ocrNumberOfPages | Number of pages to OCR (from start) | -1 |
| OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
| LLMPROMPT | llmPromptEntityName | LLM Prompt Entity Name | |
| LLMPROMPT | modelId | Override the LLM Prompt Entity model id for this action | |
| DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt Entity Name | |
| METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | |
| DELETE | deleteType | Deletion mode. CONTENT_ONLY removes the current S3 object while preserving document metadata. | SOFT_DELETE, HARD_DELETE, PURGE, CONTENT_ONLY |
| CHECKSUM | checksumType | Checksum algorithm to calculate and persist for the document | SHA1, SHA256, or SHA512 |
| FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 |
| DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt |
| DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description |
| WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint |
| NOTIFICATION | notificationType | Type of Notification | |
| NOTIFICATION | notificationToCc | Notification Carbon Copy | email@yourdomain.com |
| NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | email@yourdomain.com |
| NOTIFICATION | notificationSubject | Notification Subject | Email Subject |
| NOTIFICATION | notificationText | Notification as Text | Email Text |
| NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text |
| QUEUE | queueId | Id of Queue | |
| IDP | mappingId | Id of Mapping | |
| EVENTBRIDGE | eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | |
| RESIZE | width | The width of the image to resize (or 'auto'). | |
| RESIZE | height | The height of the image to resize (or 'auto'). | |
| RESIZE | outputType | The output type of the image (optional). | |
| RESIZE | path | The path to use when creating resized document (optional). |
Request
Responses
- 200
- 400
200 OK
Response Headers
Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers
400 OK