To preserve the integrity and reliability of the platform our APIs have the following rate limits.

For All API Endpoints, You can run a max of 10 requests/second unless noted otherwise.

User Detail and Limit

Get user detail along with the credit limit and usage information.

Definition

GET https://app.docsumo.com/api/v1/eevee/apikey/limit/ 

Example

docsumo = Docsumo(apikey=<apikey>)
docsumo.user_detail_credit_limit()

Response of API

{
    "data": {
        "document_types": [
            {
                "title": "Invoice",
                "value": "invoice"
            },
            {
                "title": "Bill of Lading",
                "value": "bill_of_lading"
            }
        ],
        "email": "[email protected]",
        "full_name": "tootlip",
        "monthly_doc_current": 7,
        "monthly_doc_limit": 1000,
        "user_id": "5e36961fe1707125e15c20af"
    },
    "error": "",
    "error_code": "",
    "message": "",
    "status": "success",
    "status_code": 200
}

Json Response Detail

Json Response DataJson Response Description
data
Dict
dict of response.
data.document_types
List
list of document types in user account.
data.document_types[].title
String
title of document.
data.document_types[].value
String
internal documents type.
data.email
String
email of user.
data.full_name
String
name of user.
data.monthly_doc_current
String
current number of documents.
data.monthly_doc_limit
String
monthly documents number limit.
data.user_idinternal user id of user.