Skip to main content

List Classifiers

Retrieve all Classifiers in your account. Results are paginated.

API Endpoint​

GET https://api.documentpro.ai/v1/classifiers

Headers​

  • x-api-key (required): Your API key for authentication.

Query Parameters​

  • pagination_key (optional): The classifier_id of the last item from a previous response, used to fetch the next page of results.

Example Implementation​

Using cURL​

curl --location 'https://api.documentpro.ai/v1/classifiers' \
--header 'x-api-key: YOUR_API_KEY'

Using Python​

import requests

url = "https://api.documentpro.ai/v1/classifiers"

headers = {
    'x-api-key': 'YOUR_API_KEY'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    result = response.json()
    for classifier in result['items']:
        print(f"{classifier['classifier_id']} — {classifier['name']}")
else:
    print('Failed to list classifiers')
    print(response.text)

Response​

Successful Response (Status Code: 200)​

{
    "success": true,
    "items": [
        {
            "classifier_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "name": "Document Type Router",
            "user_id": "4449b25a-9bba-4de4-be67-c06233d2f305",
            "configs": {
                "classifier_type": "document",
                "classes": [
                    { "label": "invoice", "description": "A document requesting payment for goods or services rendered" },
                    { "label": "purchase_order", "description": "A buyer-issued document authorizing a purchase from a supplier" }
                ],
                "query_model": "gpt-4o-mini",
                "page_range": "1-2",
                "use_ocr": true
            },
            "created_at": "2024-07-25T14:16:44.540197",
            "updated_at": "2024-07-25T14:16:44.540223"
        }
    ],
    "pagination_key": null
}

Error Response (Status Codes: 400, 403, 500)​

{
    "success": false,
    "error": "error_code",
    "message": "descriptive error message"
}

Response Fields Explained​

  • items: Array of Classifier objects. Empty array if no classifiers exist.
  • pagination_key: Pass this value as the pagination_key query parameter in your next request to retrieve the following page. null when there are no more results.

Next Steps​