Create custom category | Resemble

Create a custom fraud category from example phrases. Categories embed asynchronously: a new category starts at pending, moves to embedding, and becomes usable for scoring once its status is ready.

Authentication

AuthorizationBearer

API key from https://app.resemble.ai/hub/api

Request

This endpoint expects an object.

namestringRequired

Category name. Must be unique within the team.

scenarioslist of stringsRequired

Example phrases that define the pattern. Maximum 50 entries, each up to 2000 characters. A newline-separated string is also accepted.

descriptionstringOptional

iconstringOptional

Single emoji.

enabledbooleanOptionalDefaults to true

Response

Category created

successboolean

itemobject

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.resemble.ai/api/v2/signal/custom_categories \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Tech Support Scam",
>	"scenarios": [
>	"string"
>	]
>	}'

1	{
2	"success": true,
3	"item": {
4	"id": 1,
5	"name": "string",
6	"description": "string",
7	"icon": "string",
8	"enabled": true,
9	"status": "pending",
10	"embed_error": "string",
11	"embedded_at": "2024-01-15T09:30:00Z",
12	"scenario_count": 1,
13	"embedding_model_version": "string",
14	"overlaps": [
15	{}
16	],
17	"scenarios": [
18	{
19	"id": 1,
20	"text": "string",
21	"embedded": true
22	}
23	]
24	}
25	}