Skip to main content

Get Classifier

Retrieve the full details of a specific Classifier by its ID.

API Endpoint​

GET https://api.documentpro.ai/v1/classifiers/{classifier_id}

Path Parameters​

  • classifier_id (required): The unique identifier of the Classifier to retrieve.

Headers​

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

Example Implementation​

Using cURL​

curl --location 'https://api.documentpro.ai/v1/classifiers/f47ac10b-58cc-4372-a567-0e02b2c3d479' \
--header 'x-api-key: YOUR_API_KEY'

Using Python​

import requests

classifier_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
url = f"https://api.documentpro.ai/v1/classifiers/{classifier_id}"

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

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

if response.status_code == 200:
    classifier = response.json()
    print(f"Classifier: {classifier['name']}")
    print(f"Labels: {[c['label'] for c in classifier['configs']['classes']]}")
else:
    print('Failed to retrieve classifier')
    print(response.text)

Response​

Successful Response (Status Code: 200)​

{
    "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" },
            { "label": "contract", "description": "A legally binding agreement between two or more parties" },
            { "label": "other", "description": "Any document that does not fit the above categories" }
        ],
        "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"
}

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

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

Next Steps​