Review Queue

List External Write Proposals

get

Authorizations

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

sort_bystring[]OptionalDefault: []

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

statusstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/external-write-proposals

GET /v1/{workspace_id}/external-write-proposals 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",
      "connector_type": "text",
      "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
      "fhir_resource_type": "text",
      "fhir_resource_id": "text",
      "proposed_payload": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "confidence": 1,
      "origin_run_id": "text",
      "origin_run_kind": "text",
      "origin_event_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "proposed",
      "decided_by": "123e4567-e89b-12d3-a456-426614174000",
      "decided_at": "2026-01-01T00:00:00.000Z",
      "reject_reason": "text",
      "push_attempt_count": 0,
      "vendor_resource_id": "text",
      "error": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Get External Write Proposal

get

Authorizations

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

proposal_idstring · uuidRequired

Responses

200

Successful Response

application/json

A human-review proposal for an external (EHR) write-back — the Review Queue.

Staged by connector-runner when a review_required sink would otherwise auto-push (world.external_write_proposals); a reviewer approves/rejects, and the egress drain delivers approved ones. proposed_payload is the full FHIR write body and MAY contain PHI — this surface is workspace-scoped (FORCE-RLS) and permission-gated (ReviewQueue); never log it. connector_type/fhir_*/ status/idempotency_key are opaque strings; the ids are uuid.

idstring · uuidRequired

workspace_idstring · uuidRequired

connector_typestringRequired

data_source_idstring · uuidRequired

fhir_resource_typestringRequired

fhir_resource_idstring · nullableOptional

confidencenumber · nullableOptional

origin_run_idstring · nullableOptional

origin_run_kindstring · nullableOptional

origin_event_idstring · uuidRequired

event_typestring · nullableOptional

entity_idstring · uuid · nullableOptional

statusstring · enumRequiredPossible values:

decided_bystring · uuid · nullableOptional

decided_atstring · date-time · nullableOptional

reject_reasonstring · nullableOptional

push_attempt_countintegerOptionalDefault: 0

vendor_resource_idstring · nullableOptional

errorstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-time · nullableOptional

422

Validation Error

application/json

get/v1/{workspace_id}/external-write-proposals/{proposal_id}

GET /v1/{workspace_id}/external-write-proposals/{proposal_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",
  "connector_type": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "fhir_resource_type": "text",
  "fhir_resource_id": "text",
  "proposed_payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "confidence": 1,
  "origin_run_id": "text",
  "origin_run_kind": "text",
  "origin_event_id": "123e4567-e89b-12d3-a456-426614174000",
  "event_type": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "proposed",
  "decided_by": "123e4567-e89b-12d3-a456-426614174000",
  "decided_at": "2026-01-01T00:00:00.000Z",
  "reject_reason": "text",
  "push_attempt_count": 0,
  "vendor_resource_id": "text",
  "error": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Approve External Write Proposal

post

Authorizations

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

proposal_idstring · uuidRequired

Responses

200

Successful Response

application/json

A human-review proposal for an external (EHR) write-back — the Review Queue.

Staged by connector-runner when a review_required sink would otherwise auto-push (world.external_write_proposals); a reviewer approves/rejects, and the egress drain delivers approved ones. proposed_payload is the full FHIR write body and MAY contain PHI — this surface is workspace-scoped (FORCE-RLS) and permission-gated (ReviewQueue); never log it. connector_type/fhir_*/ status/idempotency_key are opaque strings; the ids are uuid.

idstring · uuidRequired

workspace_idstring · uuidRequired

connector_typestringRequired

data_source_idstring · uuidRequired

fhir_resource_typestringRequired

fhir_resource_idstring · nullableOptional

confidencenumber · nullableOptional

origin_run_idstring · nullableOptional

origin_run_kindstring · nullableOptional

origin_event_idstring · uuidRequired

event_typestring · nullableOptional

entity_idstring · uuid · nullableOptional

statusstring · enumRequiredPossible values:

decided_bystring · uuid · nullableOptional

decided_atstring · date-time · nullableOptional

reject_reasonstring · nullableOptional

push_attempt_countintegerOptionalDefault: 0

vendor_resource_idstring · nullableOptional

errorstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-time · nullableOptional

422

Validation Error

application/json

post/v1/{workspace_id}/external-write-proposals/{proposal_id}/approve

POST /v1/{workspace_id}/external-write-proposals/{proposal_id}/approve 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",
  "connector_type": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "fhir_resource_type": "text",
  "fhir_resource_id": "text",
  "proposed_payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "confidence": 1,
  "origin_run_id": "text",
  "origin_run_kind": "text",
  "origin_event_id": "123e4567-e89b-12d3-a456-426614174000",
  "event_type": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "proposed",
  "decided_by": "123e4567-e89b-12d3-a456-426614174000",
  "decided_at": "2026-01-01T00:00:00.000Z",
  "reject_reason": "text",
  "push_attempt_count": 0,
  "vendor_resource_id": "text",
  "error": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Reject External Write Proposal

post

Authorizations

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

proposal_idstring · uuidRequired

Body

reasonstring · min: 1 · max: 1000Required

Responses

200

Successful Response

application/json

A human-review proposal for an external (EHR) write-back — the Review Queue.

Staged by connector-runner when a review_required sink would otherwise auto-push (world.external_write_proposals); a reviewer approves/rejects, and the egress drain delivers approved ones. proposed_payload is the full FHIR write body and MAY contain PHI — this surface is workspace-scoped (FORCE-RLS) and permission-gated (ReviewQueue); never log it. connector_type/fhir_*/ status/idempotency_key are opaque strings; the ids are uuid.

idstring · uuidRequired

workspace_idstring · uuidRequired

connector_typestringRequired

data_source_idstring · uuidRequired

fhir_resource_typestringRequired

fhir_resource_idstring · nullableOptional

confidencenumber · nullableOptional

origin_run_idstring · nullableOptional

origin_run_kindstring · nullableOptional

origin_event_idstring · uuidRequired

event_typestring · nullableOptional

entity_idstring · uuid · nullableOptional

statusstring · enumRequiredPossible values:

decided_bystring · uuid · nullableOptional

decided_atstring · date-time · nullableOptional

reject_reasonstring · nullableOptional

push_attempt_countintegerOptionalDefault: 0

vendor_resource_idstring · nullableOptional

errorstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-time · nullableOptional

422

Validation Error

application/json

post/v1/{workspace_id}/external-write-proposals/{proposal_id}/reject

POST /v1/{workspace_id}/external-write-proposals/{proposal_id}/reject HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "connector_type": "text",
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "fhir_resource_type": "text",
  "fhir_resource_id": "text",
  "proposed_payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "confidence": 1,
  "origin_run_id": "text",
  "origin_run_kind": "text",
  "origin_event_id": "123e4567-e89b-12d3-a456-426614174000",
  "event_type": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "proposed",
  "decided_by": "123e4567-e89b-12d3-a456-426614174000",
  "decided_at": "2026-01-01T00:00:00.000Z",
  "reject_reason": "text",
  "push_attempt_count": 0,
  "vendor_resource_id": "text",
  "error": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}