Data Sources

List data sources

get

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

/v1/{workspace_id}/data-sources/

List data sources for a workspace with optional filtering.

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

is_activeany ofOptional

booleanOptional

or

nullOptional

source_typeany ofOptional

stringOptional

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}/data-sources/

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "name": "text",
      "display_name": "text",
      "source_type": "text",
      "connection_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "entity_types": [
        "text"
      ],
      "field_mappings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "sync_strategy": "text",
      "sync_schedule": "text",
      "last_sync_at": "2026-03-22T05:27:57.011Z",
      "last_sync_status": "text",
      "last_sync_event_count": 1,
      "is_active": true,
      "health_status": "text",
      "last_health_check": "2026-03-22T05:27:57.011Z",
      "discovered_by": "text",
      "created_at": "2026-03-22T05:27:57.011Z",
      "updated_at": "2026-03-22T05:27:57.011Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create a data source

post

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

/v1/{workspace_id}/data-sources/

Register a new external data source in the workspace.

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

display_nameany ofOptional

stringOptional

or

nullOptional

source_typestring · enumRequiredPossible values:

entity_typesstring[]Optional

sync_strategystring · enumOptionalDefault: manualPossible values:

sync_scheduleany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

post

/v1/{workspace_id}/data-sources/

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "display_name": "text",
  "source_type": "rest_api",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text"
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "source_type": "text",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "text",
  "sync_schedule": "text",
  "last_sync_at": "2026-03-22T05:27:57.011Z",
  "last_sync_status": "text",
  "last_sync_event_count": 1,
  "is_active": true,
  "health_status": "text",
  "last_health_check": "2026-03-22T05:27:57.011Z",
  "discovered_by": "text",
  "created_at": "2026-03-22T05:27:57.011Z",
  "updated_at": "2026-03-22T05:27:57.011Z"
}

Get a data source

get

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

/v1/{workspace_id}/data-sources/{data_source_id}

Retrieve a data source 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

data_source_idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

display_nameany ofRequired

stringOptional

or

nullOptional

source_typestringRequired

entity_typesany ofRequired

string[]Optional

or

nullOptional

sync_strategystringRequired

sync_scheduleany ofRequired

stringOptional

or

nullOptional

last_sync_atany ofRequired

string · date-timeOptional

or

nullOptional

last_sync_statusany ofRequired

stringOptional

or

nullOptional

last_sync_event_countintegerRequired

is_activebooleanRequired

health_statusstringRequired

last_health_checkany ofRequired

string · date-timeOptional

or

nullOptional

discovered_byany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

404

Data source not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/data-sources/{data_source_id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "source_type": "text",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "text",
  "sync_schedule": "text",
  "last_sync_at": "2026-03-22T05:27:57.011Z",
  "last_sync_status": "text",
  "last_sync_event_count": 1,
  "is_active": true,
  "health_status": "text",
  "last_health_check": "2026-03-22T05:27:57.011Z",
  "discovered_by": "text",
  "created_at": "2026-03-22T05:27:57.011Z",
  "updated_at": "2026-03-22T05:27:57.011Z"
}

Delete a data source

delete

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

/v1/{workspace_id}/data-sources/{data_source_id}

Delete a 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.

Path parameters

data_source_idstringRequired

Responses

204

Successful Response

401

Missing or invalid API key.

404

Data source not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/data-sources/{data_source_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/data-sources/{data_source_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a data source

patch

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

/v1/{workspace_id}/data-sources/{data_source_id}

Update a data source'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

data_source_idstringRequired

Body

application/json

display_nameany ofOptional

stringOptional

or

nullOptional

connection_configany ofOptional

or

nullOptional

entity_typesany ofOptional

string[]Optional

or

nullOptional

field_mappingsany ofOptional

or

nullOptional

sync_strategyany ofOptional

string · enumOptionalPossible values:

or

nullOptional

sync_scheduleany ofOptional

stringOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

display_nameany ofRequired

stringOptional

or

nullOptional

source_typestringRequired

entity_typesany ofRequired

string[]Optional

or

nullOptional

sync_strategystringRequired

sync_scheduleany ofRequired

stringOptional

or

nullOptional

last_sync_atany ofRequired

string · date-timeOptional

or

nullOptional

last_sync_statusany ofRequired

stringOptional

or

nullOptional

last_sync_event_countintegerRequired

is_activebooleanRequired

health_statusstringRequired

last_health_checkany ofRequired

string · date-timeOptional

or

nullOptional

discovered_byany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

404

Data source not found.

422

Validation Error

application/json

patch

/v1/{workspace_id}/data-sources/{data_source_id}

HTTPcURLJavaScriptPython

PATCH /v1/{workspace_id}/data-sources/{data_source_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "display_name": "text",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text",
  "is_active": true
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "display_name": "text",
  "source_type": "text",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "text",
  "sync_schedule": "text",
  "last_sync_at": "2026-03-22T05:27:57.011Z",
  "last_sync_status": "text",
  "last_sync_event_count": 1,
  "is_active": true,
  "health_status": "text",
  "last_health_check": "2026-03-22T05:27:57.011Z",
  "discovered_by": "text",
  "created_at": "2026-03-22T05:27:57.011Z",
  "updated_at": "2026-03-22T05:27:57.011Z"
}

Get data source status

get

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

/v1/{workspace_id}/data-sources/{data_source_id}/status

Get event counts, sync status, and health for a 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.

Path parameters

data_source_idstringRequired

Responses

200

Successful Response

application/json

data_source_idstringRequired

namestringRequired

is_activebooleanRequired

health_statusstringRequired

last_sync_atany ofRequired

string · date-timeOptional

or

nullOptional

last_sync_statusany ofRequired

stringOptional

or

nullOptional

last_sync_event_countintegerRequired

event_countintegerRequired

synced_countintegerRequired

failed_countintegerRequired

401

Missing or invalid API key.

404

Data source not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/data-sources/{data_source_id}/status

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/data-sources/{data_source_id}/status HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data_source_id": "text",
  "name": "text",
  "is_active": true,
  "health_status": "text",
  "last_sync_at": "2026-03-22T05:27:57.011Z",
  "last_sync_status": "text",
  "last_sync_event_count": 1,
  "event_count": 1,
  "synced_count": 1,
  "failed_count": 1
}

Get data source sync history

get

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

/v1/{workspace_id}/data-sources/{data_source_id}/sync-history

Daily event timeline + recent sync failures for a 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.

Path parameters

data_source_idstringRequired

Query parameters

daysinteger · min: 1 · max: 90OptionalDefault: 30

Responses

200

Successful Response

application/json

data_source_idstringRequired

namestringRequired

401

Missing or invalid API key.

404

Data source not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/data-sources/{data_source_id}/sync-history

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/data-sources/{data_source_id}/sync-history HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data_source_id": "text",
  "name": "text",
  "timeline": [
    {
      "date": "text",
      "event_count": 1,
      "synced_count": 1,
      "failed_count": 1
    }
  ],
  "recent_failures": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}