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
  • Getting Started
  • Step 1: Create an Account
  • Step 2: Generate an API Key
  • Using Your API Key
  • Keeping Your API Key Secure
  • Need Help?

Was this helpful?

  1. API Reference

Authentication

PreviousOverviewNextSupported File Types

Last updated 5 days ago

Was this helpful?

Securing your data and ensuring that access to the Extracta.ai API is protected are our top priorities. This section outlines the process of obtaining an API key, which is necessary for authenticating your API requests.

Getting Started

To begin using the Extracta.ai API, you'll need to obtain an API key. This key is unique to your account and serves as the credential for accessing the API.

Step 1: Create an Account

Visit to sign up for an Extracta.ai account. Fill in the required details to register and submit your registration.

Step 2: Generate an API Key

Once your account is set up, log in and navigate to the /api page on the dashboard. Here, you'll find the option to generate a new API key. Click on the "Generate a new API Key" button and follow the prompts. Your new API key will be displayed once generated. Make sure to copy and store it in a secure location.

Using Your API Key

With your API key in hand, you're ready to start making authenticated requests to the Extracta.ai API. To authenticate, include your API key in the header of each request as follows:

Authorization: Bearer <Your_API_Key_Here>

Replace <Your_API_Key_Here> with the API key you generated in the previous step.

Keeping Your API Key Secure

  • Do not share your API key publicly or with unauthorized individuals. Treat it as you would your password.

  • Regenerate your API key if you suspect it has been compromised. You can do this from the same /api page where you generated it initially.

Need Help?

If you encounter any issues while generating or using your API key, please contact support for assistance.

🔓
📧Contact Us
https://app.extracta.ai