Skip to main content

Add large document

POST 
/documents/upload

Returns a URL that can be used to upload document content and create a new document, while allowing metadata to also be sent; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB. The POST endpoint allow the adding of document metadata at the same time as the document is created.

Request​

Query Parameters

    siteId string

    Site Identifier

    contentLength integer

    Indicates the size of the entity-body

    duration integer

    Indicates the number of hours request is valid for

    shareKey string

    Share Identifier

Body

required

    documentId string

    optional Document Identifier, if skipped one will be assigned

    path string

    Path or Name of document

    contentType string

    Document media type

    width string

    Document Content Width property

    height string

    Document Content Height property

    deepLinkPath string

    Path or Name of deep link

    checksumType ChecksumType (string)

    The type of checksum to use for file validation

    Possible values: [SHA1, SHA256]

    checksum string

    The checksum value to validate the file against

    attributes

    object[]

    List of Attributes to add to document

  • Array [

    • oneOf

    Document Attribute

    key stringrequired

    Attribute key

    stringValue string

    Attribute with string value

    stringValues string[]

    Attribute with string values

    numberValue number

    Attribute with number value

    numberValues number[]

    Attribute with number values

    booleanValue boolean

    Attribute with boolean value

  • ]

    • tags

    object[]

    List of document tags

  • Array [

    • key stringrequired

    Tag key

    value string

    Tag value

    values string[]

    Tag values

  • ]

    • actions

    object[]

    List of Actions

  • Array [

    • type DocumentActionType (string)required

    Type of the Document Action

    Possible values: [ANTIVIRUS, DOCUMENTTAGGING, FULLTEXT, NOTIFICATION, OCR, QUEUE, WEBHOOK, IDP, PUBLISH, PDFEXPORT, EVENTBRIDGE, RESIZE, DATA_CLASSIFICATION, MALWARE_SCAN]

    parameters

    object

    ocrTextractQueries

    object[]

  • Array [

    • text string

    Natural-language question

    alias string

    Label to identify this query in the result

    pages string[]

    Page selection

  • ]

    • ocrParseTypes string

    OCR: Parse types - TEXT, FORMS, TABLES, QUERIES (must include ocrTextractQueries)

    ocrEngine OcrEngine (string)

    Type of OCR Engine to use

    Possible values: [TESSERACT, TEXTRACT]

    ocrOutputType OcrOutputType (string)

    OCR Engine output format (textract table only)

    Possible values: [CSV]

    ocrNumberOfPages string

    Number of pages to OCR (from start) (-1 all)

    addPdfDetectedCharactersAsText string

    OCR: For the rewriting of the PDF document, converting any image text to searchable text

    llmPromptEntityName string

    DATA_CLASSIFICATION: Set the LLM Prompt Entity Name

    url string

    Webhook: Callback URL

    characterMax string

    Fulltext: Maximum number of characters (-1 unlimited, Typesense defaults to 2048 characters)

    engine string

    DocumentTagging: Engine to use for document tagging generation

    Possible values: [chatgpt]

    notificationType string

    Notification Type

    Possible values: [email]

    notificationToCc string

    Who to carbon copy on the notification to (comma-delimited list)

    notificationToBcc string

    Who to blind carbon copy on the notification to (comma-delimited list)

    notificationSubject string

    Subject of the notification

    notificationText string

    Text of the notification

    notificationHtml string

    Html of the notification

    tags string

    DocumentTagging: Comma-deliminted list of keywords to generate tags for

    mappingId string

    Id of Mapping

    eventBusName string

    The name or ARN of the event bus to receive the event

    width string

    The width of the image to resize (or 'auto')

    height string

    The height of the image to resize (or 'auto')

    path string

    The path to use when creating resized document (optional)

    outputType string

    The output type of the image

    queueId string

    Id of Queue

  • ]

Responses​

201 CREATED

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    documentId string

    Document Identifier

    url string

    Document content url

    headers

    object

Loading...