Spade Category Personalization API
Create custom categories and personalize enrichments
Operations 16
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/categories
List default and custom integration categories · Get all default and custom integration-level categories
#
Ask an LLM
“What spending categories does Spade use by default, plus the ones I've added?”
“Can I list only my custom integration-level categories and skip the defaults?”
Tell an agent
List all default and custom integration-level categories.
Show categories filtered to the types {include}.
POST
/categories
Create a custom integration-level category · Create a custom integration-level category
#
Ask an LLM
“How do I add my own spending category that every user of my integration sees?”
“Can a custom category sit underneath one of the built-in categories?”
Tell an agent
Create an integration-wide category named {name} under parent {parentId}.
Add a custom category {name} for all my users, nested beneath {parentId}.
DELETE
/categories
Delete all custom integration-level categories · Delete all custom integration-level categories
#
Ask an LLM
“How do I remove every custom category I created for my integration at once?”
“Is there a way to reset integration categories back to only the defaults?”
Tell an agent destructive · confirm first
Delete all my custom integration-level categories.
Wipe every integration-wide custom category I've created.
DELETE
/categories/{id}
Delete one custom integration-level category · Delete a custom integration-level category
#
Ask an LLM
“How do I delete a single integration-wide custom category by its ID?”
“Can I remove one custom category without affecting my others?”
Tell an agent destructive · confirm first
Delete integration category {id}.
Remove the custom integration-level category with ID {id}.
GET
/counterparty-category-personalizations
List integration-wide counterparty category overrides · Get all integration-level counterparty category personalizations
#
Ask an LLM
“Which merchants have I re-categorized for my whole integration?”
“What counterparty category overrides apply to every user?”
Tell an agent
List all integration-level counterparty category personalizations.
Show the merchant category overrides set for my entire integration.
PUT
/counterparty-category-personalizations
Override a counterparty's category for all users · Create an integration-level counterparty category personalization
#
Ask an LLM
“How do I force a specific merchant to always map to my chosen category for every user?”
“Can I assign a custom category to a counterparty across the whole integration?”
Tell an agent
Categorize counterparty {counterpartyId} as {categoryId} for my entire integration.
Set an integration-wide category override of {categoryId} on merchant {counterpartyId}.
DELETE
/counterparty-category-personalizations
Delete all integration counterparty category overrides · Delete all integration-level counterparty category personalizations
#
Ask an LLM
“How do I clear every integration-wide merchant category override at once?”
“Can I reset all counterparty categorizations back to the defaults for everyone?”
Tell an agent destructive · confirm first
Delete all integration-level counterparty category personalizations.
Remove every merchant category override set for my integration.
DELETE
/counterparty-category-personalizations/{counterpartyId}
Remove an integration override for one counterparty · Delete a counterparty category personalization
#
Ask an LLM
“How do I undo the integration-wide category override on a single merchant?”
“Can I delete the category personalization for just one counterparty?”
Tell an agent destructive · confirm first
Delete the integration category override for counterparty {counterpartyId}.
Stop re-categorizing merchant {counterpartyId} for all users.
Ask an LLM
“What custom categories has one of my end users created?”
“Can I see the personal categories belonging to a single user?”
Tell an agent
List the custom categories for user {userId}.
Show every personal category user {userId} has made.
POST
/users/{userId}/categories
Create a custom category for one user · Create a custom user-level category
#
Ask an LLM
“How do I let an individual user add their own spending category?”
“Must a user's custom category name be unique for that user?”
Tell an agent
Create category {name} under {parentId} for user {userId}.
Add a personal category {name} nested beneath {parentId} for user {userId} only.
DELETE
/users/{userId}/categories
Delete all of a user's custom categories · Delete all custom user-level categories
#
Ask an LLM
“How do I wipe all the personal categories a single user created?”
“Can I reset one user's categories without touching integration-level ones?”
Tell an agent destructive · confirm first
Delete every custom category for user {userId}.
Clear all personal categories belonging to {userId}.
DELETE
/users/{userId}/categories/{id}
Delete one of a user's custom categories · Delete a custom user-level category
#
Ask an LLM
“How do I delete a single personal category for a specific user?”
“Can I remove one user-level category by its ID?”
Tell an agent destructive · confirm first
Delete category {id} for user {userId}.
Remove user {userId}'s personal category {id}.
GET
/users/{userId}/counterparty-category-personalizations
List a user's counterparty category overrides · Get all user-level counterparty category personalizations
#
Ask an LLM
“Which merchants has a particular user re-categorized for themselves?”
“What counterparty category overrides apply to just one user?”
Tell an agent
List the counterparty category personalizations for user {userId}.
Show the merchant category overrides user {userId} has set.
PUT
/users/{userId}/counterparty-category-personalizations
Override a counterparty's category for one user · Create a user-level counterparty category personalization
#
Ask an LLM
“How can a single user always see a certain merchant under their own category?”
“Can one user's merchant categorization differ from the rest of my integration?”
Tell an agent
For user {userId}, categorize counterparty {counterpartyId} as {categoryId}.
Set user {userId}'s category for merchant {counterpartyId} to {categoryId}.
DELETE
/users/{userId}/counterparty-category-personalizations
Delete all of a user's counterparty overrides · Delete all user-level counterparty category personalizations
#
Ask an LLM
“How do I clear every merchant category override for a single user?”
“Can I reset one user's counterparty categorizations in one call?”
Tell an agent destructive · confirm first
Delete all counterparty category personalizations for user {userId}.
Remove every merchant category override belonging to {userId}.
DELETE
/users/{userId}/counterparty-category-personalizations/{counterpartyId}
Remove a user's override for one counterparty · Delete a user-level counterparty category personalization
#
Ask an LLM
“How do I undo one user's custom category on a single merchant?”
“Can I delete a user-level personalization for just one counterparty?”
Tell an agent destructive · confirm first
Delete user {userId}'s category override for counterparty {counterpartyId}.
Stop re-categorizing merchant {counterpartyId} for user {userId}.