Documents

Categorize transactions

Categorize a document's transactions using AI. Returns cached categories if already generated (no credit charge). Otherwise deducts 1 credit and runs LLM-based categorization. Rate limit: 20 requests per minute.

post/documents/{id}/categorize

Request

  • Base URL: https://api.bankstatemently.com/v1
  • URL: https://api.bankstatemently.com/v1/documents/{id}/categorize
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

Document UUID returned by the upload endpoint.

Response

Categories returned (cached or freshly generated).

idstring uuid

Document UUID.

contentHashstring

SHA-256 content hash of the original file.

Example response

{
  "categories": {
    "mappings": {
      "1": "groceries_personal",
      "2": "meals_entertainment",
      "3": "transfers",
      "4": "utilities_telecom"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.