Unification Rules

List unification rules

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/unification-rules/

List unification rules with optional filtering by data source or active status.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

data_source_idany ofOptional

string · uuidOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

401

Missing or invalid API key.

422

Validation Error

application/json

get

/v1/{workspace_id}/unification-rules/

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/unification-rules/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "name": "text",
      "description": "text",
      "rule_type": "text",
      "data_source_id": "text",
      "source_event_type": "text",
      "target_entity_type": "text",
      "rule_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "accuracy": 1,
      "events_processed": 1,
      "last_applied_at": "2026-03-22T05:27:56.896Z",
      "created_by": "text",
      "agent_task_id": "text",
      "is_active": true,
      "created_at": "2026-03-22T05:27:56.896Z",
      "updated_at": "2026-03-22T05:27:56.896Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create a unification rule

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/unification-rules/

Create a new data mapping rule. Can be scoped to a specific data source.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Body

application/json

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

rule_typestringRequired

data_source_idany ofOptional

string · uuidOptional

or

nullOptional

source_event_typeany ofOptional

stringOptional

or

nullOptional

target_entity_typeany ofOptional

stringOptional

or

nullOptional

created_byany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

422

Invalid data_source_id reference.

post

/v1/{workspace_id}/unification-rules/

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/unification-rules/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "name": "text",
  "description": "text",
  "rule_type": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "source_event_type": "text",
  "target_entity_type": "text",
  "rule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text"
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "rule_type": "text",
  "data_source_id": "text",
  "source_event_type": "text",
  "target_entity_type": "text",
  "rule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accuracy": 1,
  "events_processed": 1,
  "last_applied_at": "2026-03-22T05:27:56.896Z",
  "created_by": "text",
  "agent_task_id": "text",
  "is_active": true,
  "created_at": "2026-03-22T05:27:56.896Z",
  "updated_at": "2026-03-22T05:27:56.896Z"
}

Get a unification rule

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/unification-rules/{rule_id}

Retrieve a unification rule by ID.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

rule_idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

descriptionany ofRequired

stringOptional

or

nullOptional

rule_typestringRequired

data_source_idany ofRequired

stringOptional

or

nullOptional

source_event_typeany ofRequired

stringOptional

or

nullOptional

target_entity_typeany ofRequired

stringOptional

or

nullOptional

accuracyany ofRequired

numberOptional

or

nullOptional

events_processedintegerRequired

last_applied_atany ofRequired

string · date-timeOptional

or

nullOptional

created_byany ofRequired

stringOptional

or

nullOptional

agent_task_idany ofRequired

stringOptional

or

nullOptional

is_activebooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

404

Unification rule not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/unification-rules/{rule_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/unification-rules/{rule_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "rule_type": "text",
  "data_source_id": "text",
  "source_event_type": "text",
  "target_entity_type": "text",
  "rule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accuracy": 1,
  "events_processed": 1,
  "last_applied_at": "2026-03-22T05:27:56.896Z",
  "created_by": "text",
  "agent_task_id": "text",
  "is_active": true,
  "created_at": "2026-03-22T05:27:56.896Z",
  "updated_at": "2026-03-22T05:27:56.896Z"
}

Delete a unification rule

delete

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/unification-rules/{rule_id}

Delete a unification rule.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

rule_idstringRequired

Responses

204

Successful Response

401

Missing or invalid API key.

404

Unification rule not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/unification-rules/{rule_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/unification-rules/{rule_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a unification rule

patch

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/unification-rules/{rule_id}

Update a unification rule's configuration.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

rule_idstringRequired

Body

application/json

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

rule_typeany ofOptional

stringOptional

or

nullOptional

data_source_idany ofOptional

string · uuidOptional

or

nullOptional

source_event_typeany ofOptional

stringOptional

or

nullOptional

target_entity_typeany ofOptional

stringOptional

or

nullOptional

rule_configany ofOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

descriptionany ofRequired

stringOptional

or

nullOptional

rule_typestringRequired

data_source_idany ofRequired

stringOptional

or

nullOptional

source_event_typeany ofRequired

stringOptional

or

nullOptional

target_entity_typeany ofRequired

stringOptional

or

nullOptional

accuracyany ofRequired

numberOptional

or

nullOptional

events_processedintegerRequired

last_applied_atany ofRequired

string · date-timeOptional

or

nullOptional

created_byany ofRequired

stringOptional

or

nullOptional

agent_task_idany ofRequired

stringOptional

or

nullOptional

is_activebooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

404

Unification rule not found.

422

Invalid data_source_id reference.

patch

/v1/{workspace_id}/unification-rules/{rule_id}

HTTPcURLJavaScriptPython

PATCH /v1/{workspace_id}/unification-rules/{rule_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "name": "text",
  "description": "text",
  "rule_type": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "source_event_type": "text",
  "target_entity_type": "text",
  "rule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_active": true
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "rule_type": "text",
  "data_source_id": "text",
  "source_event_type": "text",
  "target_entity_type": "text",
  "rule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accuracy": 1,
  "events_processed": 1,
  "last_applied_at": "2026-03-22T05:27:56.896Z",
  "created_by": "text",
  "agent_task_id": "text",
  "is_active": true,
  "created_at": "2026-03-22T05:27:56.896Z",
  "updated_at": "2026-03-22T05:27:56.896Z"
}