DOdocsumo
Documents

Upload from URL or Base64

Upload a document from a public URL or by providing its Base64 encoded content.

post/api/v1/eevee/apikey/upload/custom/

Request

  • Base URL
    https://app.docsumo.com
  • URL
    https://app.docsumo.com/api/v1/eevee/apikey/upload/custom/
  • Auth
    none declared. Required headers: apikey

Headers

apikeystring required

Your personal API key for authentication. You can find it on your Docsumo settings page.

Request body multipart/form-data

filestring required

The public URL of the file or the Base64-encoded file content.

typestring required

The type of document being uploaded. Obtain the list of available types from the 'Get User Details and Document Types' endpoint.

user_doc_idstring

An optional, unique identifier that you can assign to the document for your own internal tracking purposes.

doc_meta_datastring

Optional JSON string containing any additional metadata you want to associate with the document.

filenamestring

The name for the file, including its extension. This is required when uploading a file using Base64.

file_type'url' | 'base64' required

Specifies whether the file parameter contains a url or base64 content.

review_tokenboolean

If true, the response will include a temporary, signed review URL that can be shared with external users.

passwordstring

The password for the document, if it is password-protected.

Example request

{
  "file": "https://templates.invoicehome.com/invoice-template-us-classic-white-750px.png",
  "type": "invoice",
  "filename": "example.png"
}

Response

OK

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error, if any.

messagestring

Additional information or context about the response.

statusstring

The status of the request (e.g., 'success' or 'fail').

status_codeinteger

The HTTP status code of the response.

Changes

No recorded changes to this operation across all 2 revisions of this API.