Getting Started with DocuProx

Get up and running with DocuProx AI document extraction in minutes. This guide covers everything from account setup to your first successful API call.

Introduction

DocuProx is a powerful, AI-driven SaaS platform designed to intelligently extract structured data from images and PDF documents like invoices, passports, and government IDs. Built with an API-first approach, DocuProx provides a robust RESTful API specifically designed for seamless integration into your existing systems. Using configurable templates (value-based, annotation-based, and prompt-based extraction methods), DocuProx eliminates manual data entry, enhances accuracy, and accelerates your business processes by transforming unstructured document data into ready-to-use JSON format that can be directly consumed by your applications.

Getting Started with DocuProx

Getting started with DocuProx is straightforward and requires just a few simple steps:

1

Sign In

Create your DocuProx account and access the platform

Don't have access? Request access through our signup request form

2

Generate API Key

Create a secure API key for authentication

3

Configure Templates

Set up templates using value-based, annotation-based, or prompt-based extraction methods

4

Define JSON Structure

Specify the exact JSON format for your extracted data

5

Test Template

Upload sample images to validate template output, check accuracy, and adjust template configuration if needed

6

Integrate Your System

Use your template ID along with images or PDFs to extract structured data via API calls

API Integration Flow

Customer System

Your existing business systems, such as Salesforce, ServiceNow, or custom applications.

API Call

DocuProx API

Handles secure and scalable document processing and data extraction via RESTful endpoints.

What this documentation covers:

  • Platform Overview: Understanding what DocuProx is and its core capabilities.
  • Quick Start Guide: Essential steps to get you up and running quickly, including API key generation, template configuration, and testing.
  • Core Topics: Detailed explanations of how DocuProx works, template management, integration with your applications, and monitoring your usage.
  • Resources: Information on SDKs, libraries, and examples to aid in your development.
  • FAQs: Answers to frequently asked questions and troubleshooting tips.

Quick Start

This section will guide you through the essential steps to quickly get started with DocuProx.

1 Logging In and Navigating the Dashboard

When you access DocuProx, first you will need to log in with your Email ID and Password. After successful login, you will see your Dashboard and the left sidebar navigation.

Sidebar Navigation

The left sidebar provides quick access to the main areas of the application:

  • • Dashboard
  • • Templates
  • • Manage Users
  • • Profile
  • • Settings

Dashboard Overview

The Dashboard provides a quick summary of your account's performance and usage. Here you will find real-time metrics and analytics, helping you monitor your document processing activities.

Key Dashboard Metrics:

Usage Summary
  • • API Requests count
  • • Credits Used/Remaining
  • • Success Rate percentage
Analytics Filters
  • • Last 7 days
  • • Last 30 days
  • • Last 90 days
Graphs & Trends
  • • Requests Over Time
  • • Success & Error Rates
  • • Response Time Trend

2 How to Generate an API Key

Your API Key is crucial for securely integrating DocuProx with your applications and for testing templates.

1 Log in to your DocuProx account.
2 Navigate to the "Settings" section from the main navigation.
3 On the "Settings" page, find the "API Access" section which includes "API Key Management".
4 Click on the "Generate New API Key" button.
5 A unique API key will be generated for you. Important: Copy this key immediately and store it in a safe and secure place.

Security Warning

For security reasons, this key will only be fully visible once. If you lose it, you will need to generate a new one. You can also revoke existing keys from here.

3 How to Configure a Template

Templates are blueprints that define how DocuProx extracts data from your documents.

Template Creation Steps:

1 From the sidebar, click on the "Templates" title.
2 Click the "Create new Template" button.
3 Configure template details: Name, Description, Document Type.
4 Choose Reference Image Mode (with or without reference image).
5 Configure data extraction methods and JSON structure.

Data Extraction Methods:

Label-Value Extraction (Prompt-based)

Highly effective when information has associated labels (e.g., "Name:", "Date:", "Invoice Total:").

Annotation-based Extraction (Visual)

Powerful for extracting data from specific, visually defined document areas, even without clear textual labels.

4 How to Test a Template

Thorough template testing is crucial to ensure accurate data extraction prior to large-scale deployment.

1 Navigate to the "Test Template" tab within the template editor.
2 Input your API Key in the "API Configuration" section.
3 Upload a sample document (PNG, JPG, up to 100MB) in the "Upload Test Image" section.
4 Click "Test Template" to process the document.
5 Review the extracted data in the results section.
6 Adjust template configuration if needed and test again.

5 How to Integrate DocuProx with Your Application

DocuProx is designed for seamless integration into virtually any application, system, or workflow. Its API-first design ensures maximum flexibility.

Use Your API Key

The API key generated in Step 2 is your authentication token for all API requests.

Refer to API Documentation

For detailed integration instructions, including API endpoints, request/response formats, and code examples.

Utilize SDKs/Libraries

DocuProx offers SDKs or libraries in popular programming languages to simplify integration.

Ready to explore more?

Now that you understand the basics, dive deeper into DocuProx features and capabilities.

Explore Core Features View API Reference