Classify

A Classification picks the category of a document out of a list you define. It reads the document content and maps it to the most relevant category, with a motivation, enabling automated sorting and routing of incoming files.

• Your Taxonomy: each category has a name and a description that tells the model when to pick it.
• Semantic Reasoning: the model understands context and intent, classifying files even without specific keyword matches.
• No Forced Choice: by default the model may return no category when the file fits none.

🏗️ ConfigurationCopy Anchor Link

A Classification is an Operation: it parses the Document, then classifies it.

The model reads the first 5,000 characters of the parsed Document; when it is longer, the Output reports truncated: true.

🛠️ Classify a DocumentCopy Anchor Link

For every field and parameter, see the Classifications reference.

Submit a ClassificationCopy Anchor Link

curl -X POST "https://api.axelered.com/v1/classifications?wait=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/legal_form.pdf" \
  -F 'config={
    "categories": [
      { "name": "invoice", "description": "A bill for goods or services" },
      { "name": "contract", "description": "An agreement between parties" }
    ],
    "allowEmpty": false
  }'

Once the Classification is done, the category is in its output:

{
  "status": "done",
  "output": {
    "value": {
      "category": { "name": "contract", "description": "An agreement between parties" },
      "motivation": "..."
    },
    "truncated": false
  }
}

List, Read & DeleteCopy Anchor Link

• List Classifications: newest first, optionally for one Document with ?documentId=. Lists leave out the output.
• Read Classification: status, credits and output, with optional wait.
• Delete Classification: hide a Classification. Its Document is kept.