Download Export Data

The Export Data API enables you to download data by providing account credentials and specifying the export template you have created. To access this functionality:

1. Access the Workspace Setup section.

2. Choose the desired workspace.

3. Enter edit mode for the selected workspace.

4. Click on the View icon to display a comprehensive list of details related to the export data process.

Download Export Data

POST https://app.sagexglobal.ai/api/document/export/download

This is HTTPS POST method to download the export data from your Account Workspace

Authorization

Bearer Token : <API Key>

The client must send this API Key in the Authorization header when making requests to protected resources

Request Body

Name	Type	Description
realm_id*	Text	realm id of your account
workspace_guid*	Text	workspace_id of your account
cluster_guid*	Text	cluster id of your workspace
export_template_guid*	Text	export template id
export_format*	Text	export format JSON or CSV

200: OK Success

{//sample reponse
    "data": [
        {
            "record_id": "4ff0bb7e-2b8e-4455-8bb7-d919c44c691a",
            "document_name": "example.pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "02/11/90",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "4ff0bb7e-2b8e-4455-8bb7-d919c44c691a"
        },
        {
            "record_id": "1c14ebfb-26c7-4e31-95a9-b80122b175c5",
            "document_name": "sodapdf-converted (3).pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "2001/11/02",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "1c14ebfb-26c7-4e31-95a9-b80122b175c5"
        },
        {
            "record_id": "7a941bef-3119-4193-8c36-8ced9935793b",
            "document_name": "sodapdf-converted (3).pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "30/08/98",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "7a941bef-3119-4193-8c36-8ced9935793b"
        },
        {
            "record_id": "bc671f73-69e4-4747-a310-89b8bf2a47b4",
            "document_name": "sodapdf-converted (3).pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "12/15/2000",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "bc671f73-69e4-4747-a310-89b8bf2a47b4"
        },
        {
            "record_id": "7839a673-e66d-4422-94bf-c185a157270f",
            "document_name": "sodapdf-converted (3).pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "02/11/1990",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "7839a673-e66d-4422-94bf-c185a157270f"
        },
        {
            "record_id": "499d9c88-99c1-4774-9a7d-93eec08e46d1",
            "document_name": "sodapdf-converted (3).pdf",
            "is_deleted": false,
            "document_guid": "3a4f4360-045a-11ee-a898-05fd41ed23b7",
            "fields": [
                {
                    "value_text": "98/07/23",
                    "title": "FC1_1",
                    "sort_order": 1
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_2",
                    "sort_order": 2
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_3",
                    "sort_order": 3
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_4",
                    "sort_order": 4
                },
                {
                    "value_text": "~NA~",
                    "title": "FC1_5",
                    "sort_order": 5
                }
            ],
            "id": "499d9c88-99c1-4774-9a7d-93eec08e46d1"
        }
    ],
    "status": "success",
    "message": "Records"
}

Take a look at how you might call this method using our API's, or via curl:

Curl

curl -H "Authorization: Bearer <token>"
--location 'https://app.sagexglobal.ai/api/document/export/download' \
--form 'realm_guid="<realm_id>"' \
--form 'workspace_guid="<workspace_guid>"' \
--form 'cluster_guid="<cluster_guid>"' \
--form 'export_template_guid="<export_template_guid>"' \
--form 'export_format="CSV"'