API Guide
    API Guide
    • Get Started
    • Document AI
      • Malaysia
        • Extract Bank Statement Data
        • Extract Bill of Lading Data
        • Extract Business Card Data
        • Extract Car Meter Data
        • Extract Cheque (Front) Data
        • Extract Company Financial Statement Data
        • Extract Resume Data
        • Extract E-Invoice Data
        • Extract Electricity Bill Data
        • Extract Identity Card Data
        • Extract Invoice Data
        • Extract Passport Data
        • Extract Payslip Data
        • Extract Price Tag Data
        • Extract Purchase Order Data
        • Extract Receipt (General) Data
        • Extract SSM Documents Data
        • Extract Water Bill Data
      • Thailand
        • Extract Business Card Data
        • Extract Identity Card Data
        • Extract Passport Data
        • Extract Receipt Data
      • Vietnam
        • Extract Business Card Data
        • Extract Identity Card Data
        • Extract Passport Data
        • Extract Receipt Data
      • Philippines
        • Extract Business Card Data
        • Extract Identity Card Data
        • Extract Passport Data
        • Extract Receipt Data

    Get Started

    API Reference#

    The Axtraction AI API provides a robust REST-like interface that enables you to extract information from documents using advanced AI techniques.
    Whether you're working with bank statements, payslips, or any other document types, the Axtraction AI API offers endpoints that integrate effortlessly into your tech stack.
    The API reference includes detailed documentation for each endpoint and operation available.
    Base URL: https://api.axtraction.ai/v1/document

    Authentication#

    To interact with the Axtraction AI API, you must authenticate your requests using an API key. You can obtain your API key from the Developer page on the Axtraction AI web app.

    API Key Usage#

    Header: Include your API key in the request header as follows:
    X-API-KEY: your_api_key_here

    Example Header#

    HTTP Request:
    Where {model-id} is the model ID, such as model-a1b2c3d4e5f6, which consists of a 12-character string made up of letters a-f and numbers 0-9.
    cURL Command:
    All API requests must be made over HTTPS to ensure the security of your data. Requests sent without authentication will fail.
    Keep your API key secure! Do not share it in publicly accessible areas such as GitHub, client-side code, or other insecure locations.

    Errors#

    The Axtraction AI API uses conventional HTTP response codes to indicate the success or failure of an API request. Generally:
    • Codes in the 2xx range indicate success.
    • Codes in the 4xx range indicate client-side errors.
    • Codes in the 5xx range indicate server-side errors.

    Status Codes#

    CodeStatusDescription
    200OKThe request was successful, and the server responded with the expected data.
    400Bad RequestThe request could not be processed because of client-side issues, such as missing or invalid parameters.
    401UnauthorizedAuthentication failed or was not provided. A valid API key is required to access the resource or it has expired.
    403ForbiddenToken is disabled or quota exceeded.
    404Not FoundThe requested resource could not be found on the server.
    500Internal Server ErrorThe server encountered an unexpected condition that prevented it from fulfilling the request.
    For more information on the endpoints and functionalities, please refer to the API reference documentation.
    Modified at 2025-05-08 02:12:02
    Next
    Extract Bank Statement Data
    Built with