Extracta.ai
DashboardJoin Discord
  • extracta.ai
    • Introduction
    • Overview
  • API Reference
    • 🔓Authentication
    • 📁Supported File Types
  • Data Extraction - API
    • đŸ’ģAPI Endpoints - Data Extraction
      • 1. Create extraction
      • 2. View extraction
      • 3. Update extraction
      • 4. Delete extraction
      • 5. Upload Files
      • 6. Get results
    • Extraction Details
      • 🌎Supported Languages
      • âš™ī¸Options
      • 📋Fields
    • Receiving Batch Results
      • Polling vs Webhook
      • How to use the Webhook
    • đŸ•šī¸Postman Integration
  • Document Classification - API
    • đŸ’ģAPI Endpoints - Document Classification
      • 1. Create classification
      • 2. View classification
      • 3. Update classification
      • 4. Delete data
        • 4.1 Delete classification
        • 4.2 Delete batch
        • 4.3 Delete files
      • 5. Upload Files
      • 6. Get results
    • Classification Details
      • 📄Document Types
  • Documents
    • Custom Document
    • Resume / CV
    • Contract
    • Business Card
    • Email
    • Invoice
    • Receipt
    • Bank Statement
  • Support
    • 💁Tutorials
    • đŸŸĸAPI Status
  • Contact
    • 📧Contact Us
    • ❓FAQ
Powered by GitBook
On this page
  • Understanding RESTful APIs
  • Available Endpoints
  • Postman Collection
  • Navigating the Documentation

Was this helpful?

  1. Data Extraction - API

API Endpoints - Data Extraction

Welcome to the Extracta.ai API Reference. This section is your comprehensive guide to the full suite of API endpoints. Our goal is to equip you with all the information needed to integrate our powerful data extraction capabilities seamlessly into your applications and workflows.

Understanding RESTful APIs

Our API adheres to RESTful principles, making it intuitive and straightforward for developers to use. REST, or Representational State Transfer, is an architectural style that uses HTTP requests to access and manipulate data. The RESTful approach ensures that our API is scalable, reliable, and easy to consume.

Available Endpoints

The Extracta.ai API offers the following endpoints to facilitate your document parsing needs:

Endpoint
Type
Page

/createExtraction

POST

/viewExtraction

POST

/updateExtraction

PATCH

/deleteExtraction

DELETE

/uploadFiles

POST

/getBatchResults

POST

For more details on each endpoint, including request parameters, response objects, and example requests and responses, please navigate to the specific page dedicated to that endpoint.

Postman Collection

For a complete and interactive set of API requests, please refer to our Postman Integrationcollection.

Navigating the Documentation

For each endpoint, we provide a dedicated page that dives deep into:

  • Request Parameters: Detailed descriptions of all parameters you can use in your requests, allowing you to customize your API calls to fit your needs precisely.

  • Response Objects: Insight into the structure and content of the API responses, helping you understand how to interpret and use the data returned by the API.

  • Example Requests and Responses: Practical examples to guide you through constructing requests and handling responses, making your development process smoother and more efficient.

This structured approach ensures that you have access to all the necessary details to make the most of the Extracta.ai API, regardless of your specific requirements or use case.

PreviousSupported File TypesNext1. Create extraction

Last updated 17 hours ago

Was this helpful?

đŸ’ģ
1. Create extraction
2. View extraction
3. Update extraction
4. Delete extraction
5. Upload Files
6. Get results