💁Tutorials

Welcome to the Extracta.ai tutorials page! Here, we provide step-by-step guides to help you get started with our API. Whether you're new to Extracta.ai or looking to explore more advanced features, these tutorials are designed to equip you with the knowledge to integrate our API seamlessly into your workflows.

Getting Started

How to Make an Account and Obtain an API Key

  1. Sign Up: Visit https://app.extracta.ai and sign up for an account to get started.

  2. Generate API Key: Once logged in, navigate to the /api section of your dashboard. Here, you can generate a new API key by clicking on the "Generate API Key" button.

  3. Keep Your API Key Secure: Store your API key in a safe place. It's your unique identifier and grants access to the API's capabilities.

Authentication

First API Call: Creating an Extraction

Learn how to make your first API call to create an extraction template. This tutorial covers the basics of forming a request to our /createExtraction endpoint.

1. Create extraction

Postman Collection

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

Document Types

Parsing a Resume

This tutorial walks you through the process of extracting data from a resume using a predefined template. It includes steps for preparing the request and handling the extracted data.

Resume / CV

Working with Custom Documents

Discover how to parse custom documents by specifying your own fields for extraction. This guide provides insights into customizing your extraction request for various document types.

Custom Document

Advanced Topics

Batch Processing

Learn how to upload and process documents in batches, a feature that enhances efficiency by handling multiple documents in a single request.

5. Upload Files

Receiving Batch Results: Polling vs. Webhook

This tutorial explains the two methods of receiving batch results: polling and using a webhook for real-time updates. Understand the pros and cons of each method and how to implement them.

Polling vs Webhook

FAQ

Find answers to common questions about using the Extracta.ai API, troubleshooting, and best practices.

❓FAQ

Need More Help?

If you encounter any issues or have further questions, our support team is here to assist you. Visit our Contact page for more information.

📧Contact Us

Last updated