Data Sources

List data sources

get

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.

Path parameters

workspace_idstring · uuidRequired

Query parameters

is_activeboolean · nullableOptional

source_typestring[] · nullableOptional

Filter by source type (repeatable)

searchstring · nullableOptional

Search by name, ID, type, or sync status

limitinteger · max: 100OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokeninteger · nullableOptional

totalinteger · nullableOptional

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "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",
      "last_sync_at": "2026-07-10T21:38:44.322Z",
      "last_sync_status": "success",
      "last_sync_event_count": 1,
      "is_active": true,
      "is_stale": true,
      "health_status": "unknown",
      "created_at": "2026-07-10T21:38:44.322Z",
      "updated_at": "2026-07-10T21:38:44.322Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create a data source

post

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.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

namestring · min: 1 · max: 256Required

display_namestring · min: 1 · max: 256 · nullableOptional

source_typestring · enumRequiredPossible values:

entity_typesstring[] · max: 100Optional

sync_strategystring · enumOptionalDefault: manualPossible values:

sync_schedulestring · max: 256 · nullableOptional

Responses

201

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

display_namestring · nullableRequired

source_typestring · enumRequiredPossible values:

entity_typesstring[] · nullableRequired

sync_strategystring · enumRequiredPossible values:

sync_schedulestring · nullableRequired

last_sync_atstring · date-time · nullableRequired

last_sync_statusstring · enum · nullableRequiredPossible values:

last_sync_event_countintegerRequired

is_activebooleanRequired

is_stalebooleanRequired

health_statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

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: 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": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "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",
  "last_sync_at": "2026-07-10T21:38:44.322Z",
  "last_sync_status": "success",
  "last_sync_event_count": 1,
  "is_active": true,
  "is_stale": true,
  "health_status": "unknown",
  "created_at": "2026-07-10T21:38:44.322Z",
  "updated_at": "2026-07-10T21:38:44.322Z"
}

Get a data source

get

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

display_namestring · nullableRequired

source_typestring · enumRequiredPossible values:

entity_typesstring[] · nullableRequired

sync_strategystring · enumRequiredPossible values:

sync_schedulestring · nullableRequired

last_sync_atstring · date-time · nullableRequired

last_sync_statusstring · enum · nullableRequiredPossible values:

last_sync_event_countintegerRequired

is_activebooleanRequired

is_stalebooleanRequired

health_statusstring · enumRequiredPossible values:

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "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",
  "last_sync_at": "2026-07-10T21:38:44.322Z",
  "last_sync_status": "success",
  "last_sync_event_count": 1,
  "is_active": true,
  "is_stale": true,
  "health_status": "unknown",
  "created_at": "2026-07-10T21:38:44.322Z",
  "updated_at": "2026-07-10T21:38:44.322Z"
}

Delete a data source

delete

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Responses

204

Successful Response

No content

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a data source

patch

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Body

application/json

display_namestring · min: 1 · max: 256 · nullableOptional

entity_typesstring[] · max: 100 · nullableOptional

sync_strategystring · enum · nullableOptionalPossible values:

sync_schedulestring · max: 256 · nullableOptional

is_activeboolean · nullableOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

display_namestring · nullableRequired

source_typestring · enumRequiredPossible values:

entity_typesstring[] · nullableRequired

sync_strategystring · enumRequiredPossible values:

sync_schedulestring · nullableRequired

last_sync_atstring · date-time · nullableRequired

last_sync_statusstring · enum · nullableRequiredPossible values:

last_sync_event_countintegerRequired

is_activebooleanRequired

is_stalebooleanRequired

health_statusstring · enumRequiredPossible values:

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: 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": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "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",
  "last_sync_at": "2026-07-10T21:38:44.322Z",
  "last_sync_status": "success",
  "last_sync_event_count": 1,
  "is_active": true,
  "is_stale": true,
  "health_status": "unknown",
  "created_at": "2026-07-10T21:38:44.322Z",
  "updated_at": "2026-07-10T21:38:44.322Z"
}

Get data source status

get

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Responses

200

Successful Response

application/json

data_source_idstring · uuidRequired

namestringRequired

is_activebooleanRequired

health_statusstring · enumRequiredPossible values:

last_sync_atstring · date-time · nullableRequired

last_sync_statusstring · enum · nullableRequiredPossible values:

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "is_active": true,
  "health_status": "unknown",
  "last_sync_at": "2026-07-10T21:38:44.322Z",
  "last_sync_status": "success",
  "last_sync_event_count": 1,
  "event_count": 1,
  "synced_count": 1,
  "failed_count": 1
}

Get data source sync history

get

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Query parameters

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

Responses

200

Successful Response

application/json

data_source_idstring · uuidRequired

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: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "timeline": [
    {
      "date": "text",
      "event_count": 1,
      "synced_count": 1,
      "failed_count": 1
    }
  ],
  "recent_failures": [
    {
      "event_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "text",
      "fhir_resource_type": "text",
      "fhir_resource_id": "text",
      "sync_error": "text",
      "created_at": "text"
    }
  ]
}

Trigger a manual sync for a data source

post

Queues a one-off poll of the data source on connector-runner. Bypasses the business-hours gate and per-resource cadence counter. Returns 202 once the request is queued; the poll itself runs asynchronously. Returns 409 if the source is already mid-sync, 503 if connector-runner is unreachable. The 409 is best-effort: the status check and trigger are separate calls, so a scheduled poll can grab the lease between them — clients should treat 409 as a UX hint, not a hard guarantee.

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

workspace_idstring · uuidRequired

data_source_idstring · uuidRequired

Responses

202

Successful Response

application/json

statusconst: startedRequired

data_source_idstring · uuidRequired

triggered_atstring · date-timeRequired

400

Invalid data source ID format.

401

Missing or invalid API key.

404

Data source not found.

409

Data source is already syncing.

application/json

422

Validation Error

application/json

429

Rate limit exceeded.

503

Connector-runner is unreachable.

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

HTTPcURLJavaScriptPython

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

{
  "status": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "triggered_at": "2026-07-10T21:38:44.322Z"
}