Docunova API Reference

This API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Just Getting Started?

Check out our development quickstart guide (link to be added).

Authentication

Docunova API uses API keys to authenticate requests. You can view and manage your API keys in the Console page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

For the external API, include your API key in the x-api-key header:

your_api_key_here

For the iOS API, authentication is handled through Cognito. Include the Cognito token in the Authorization header:

your_cognito_token_here

Endpoints

Analyze Image (External API)

Analyzes the image and extracts data based on the provided schema.

URL: /image/analyze
Method: POST
Auth required: Yes (API Key)

Parameters

Name	Located in	Description	Required	Schema
image	body	Base64 encoded image data	Yes	string
contentType	body	MIME type of the image	Yes	string
schema	body	Schema for data extraction	No	string
format	body	Output format (JSON or CSV)	No	string

Request Body Example

}

Responses

;

Analyze Image (iOS API)

Analyzes the image and extracts data based on the provided schema.

URL: /image/analyze
Method: POST
Auth required: Yes (Cognito Token)

Parameters

Name	Located in	Description	Required	Schema
userId	body	User ID	Yes	string
image	body	Base64 encoded image data	Yes	string
contentType	body	MIME type of the image	Yes	string
schema	body	Schema for data extraction	No	string
format	body	Output format (JSON or CSV)	No	string

Request Body Example

}

Responses

;

Rate Limiting

Each subscription tier has its own rate limit. When you become a member, you start by choosing a tier that suits your usage needs. You can upgrade or downgrade your plan at any time.

;

When you reach a rate limit, the service will return an HTTP 429 response status code (Too Many Requests) with an error message in the response body.

You can programmatically check your rate limit usage. Each response includes the following headers:

x-ratelimit-limit-month: Request limit per month
x-ratelimit-remaining-month: Request limit remaining this month
x-ratelimit-limit-day: Request limit per day
x-ratelimit-remaining-day: Request limit remaining today

Error Codes

Docunova API uses standard HTTP response codes to indicate the success or failure of an API request.

2xx range indicate success
4xx range indicate a client-side error
5xx range indicate a server-side error

Status Code	Explanation
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key or authentication token provided.
429 - Too Many Requests	API request limit exceeded.
502 - Bad Gateway	Upstream service failure.
5xx - Server Error	We have failed to process your request.