Getting Started
Overview Supported Languages File Types Test Mode Postman Collection Tools and APIsPricing
Pricing Calculate Credit Usage Pricing per ToolDeveloper Guides
API Overview Authentication Errors Combine Workflows Performance PDF Generation API ReferenceSupported Languages
Java C# JavaScript Python PHP Other Languages Deployment Options Security Privacy Support About NutrientPricing
With the Nutrient DWS API, you can use API credits to perform a variety of document management actions in a single request. We use an API credit system to track usage. Your credit quota will vary depending on your plan. In this guide, we’ll discuss how credits are spent and how you can use them to process document operations.
What Is an API credit?
Each subscription plan we offer allows you to spend a certain amount of credits. When you make a request to Nutrient’s API using your live API key to process a document, a specific number of credits will be deducted from your subscription. Credit deduction is based on the complexity of the document operation—simple operations cost less than complex ones. The credit amount ranges from 0.5 to 10 for our API actions. Refer to the calculate credit usage article for more details.
Can I Combine Multiple API Actions When Processing One Document?
Yes, you can combine multiple API actions in a single request to create a complex document processing workflow.
Depending on the complexity of the chosen API actions, a single document processing workflow may cost more than one credit. Please refer to the calculate credit usage article for more details.
To learn more about combining API actions, we’ve provided some example use cases in our combine workflow documentation.
How Does the Yearly Subscription Work?
The yearly subscription works the same as the monthly subscription, with the only difference being that you receive a 10 percent discount on the price by paying in advance for the entire year instead of paying for it month by month. Based on the package you choose, you’ll make one annual payment and then be able to process a set number of documents each month.
How Do I Cancel My Subscription Plan?
You can cancel your subscription plan at any time. Once canceled, we’ll immediately stop charging you. At the time of cancellation, any unused credits that you have available in your account will remain available to you until the end of your subscription period.
How Can I Test the API?
If you need to test our API without purchasing a plan, you can sign up for a free account, or contact us for a test API key.
How do I calculate the number of credits my API request will consume?
There are multiple ways to find out how many credits a specific API request consumes. Please refer to the calculate credit usage article for more details.
I am an existing customer. Do I need to upgrade to the new billing system?
No, you can continue using the legacy plan for as long as you like. However, the new billing model offers additional API tools, including Digital Signatures. In the new billing model, different document operations have variable costs: simpler operations require fewer credits, while more complex ones require more credits. This allows for more precise cost management and access to advanced features as needed.
How do I upgrade my plan to get more credits?
You can upgrade your plan by visiting the billing section of your account dashboard. Select the plan that suits your needs and follow the instructions to upgrade. If you need assistance, our support team is available to help.
Can I monitor my API credit usage?
Yes, you can monitor your API credit usage through the dashboard provided in your account. It displays the number of available credits, helping you manage and optimize your usage effectively.
How many credits do I need to digitally sign a document?
You need 10 API credits to initiate the eSignature API action and digitally sign your documents. Use our calculator above to get an estimate of how many credits you need for each operation.
How many credits do I need to perform OCR on the document?
You need 3 credits to initiate the PDF OCR API action and make any document searchable, regardless of the number of pages. Use our calculator above to get an estimate of how many credits you need for each operation.
How many credits do I need to create and fill out the form?
You need 1 credit in total for these two form API actions. Use our calculator above to get an estimate of how many credits you need for each operation.
How many credits do I need to generate a PDF file and archive it?
You will need 1.5 credit for these two actions. Use our calculator above to get an estimate of how many credits you need for each operation.
How many credits do I need to annotate and redact a PDF file?
You will need 1.5 credit for these two actions. Use our calculator above to get an estimate of how many credits you need for each operation.