Audit

List Audit Events

get

List audit events with filters and pagination.

Permissions: admin, owner (Audit.view)

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

servicestring · max: 64 · nullableOptional

Filter by service name

actionstring · max: 128 · nullableOptional

Filter by action type

actor_entity_idstring · uuid · nullableOptional

Filter by actor entity

resource_typestring · max: 64 · nullableOptional

Filter by resource type

resource_idstring · uuid · nullableOptional

Filter by specific resource

phi_onlybooleanOptional

Only PHI access events

Default: false

date_fromstring · date-time · nullableOptional

Start of date range

date_tostring · date-time · nullableOptional

End of date range

limitinteger · min: 1 · max: 100Optional

Page size

Default: 50

offsetintegerOptional

Page offset

Default: 0

Responses

200

Successful Response

application/json

totalintegerRequired

limitintegerRequired

offsetintegerRequired

has_morebooleanRequired

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/audit

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

{
  "events": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "text",
      "service": "text",
      "actor_entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "actor_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "action": "text",
      "resource_type": "text",
      "resource_id": "text",
      "resource_name": "text",
      "ip_address": "text",
      "user_agent": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "phi_accessed": false
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_more": true
}

Get Phi Access Report

get

PHI access report — who accessed what patient data, when, from where.

Required for HIPAA breach investigation (§164.312(b)).

Permissions: admin, owner (Audit.view)

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

entity_idstring · uuid · nullableOptional

Filter by patient entity

date_fromstring · date-time · nullableOptional

Start of date range

date_tostring · date-time · nullableOptional

End of date range

limitinteger · min: 1 · max: 100Optional

Page size

Default: 50

offsetintegerOptional

Page offset

Default: 0

Responses

200

Successful Response

application/json

totalintegerRequired

limitintegerRequired

offsetintegerRequired

has_morebooleanRequired

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/audit/phi-access

GET /v1/{workspace_id}/audit/phi-access HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "events": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "text",
      "service": "text",
      "actor_entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "actor_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "action": "text",
      "resource_type": "text",
      "resource_id": "text",
      "resource_name": "text",
      "ip_address": "text",
      "user_agent": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "phi_accessed": false
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_more": true
}

Get Entity Access Log

get

Per-entity access history — all audit events for a specific resource.

Permissions: admin, owner (Audit.view)

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

entity_idstring · uuidRequired

Query parameters

date_fromstring · date-time · nullableOptional

Start of date range

date_tostring · date-time · nullableOptional

End of date range

limitinteger · min: 1 · max: 100Optional

Page size

Default: 50

offsetintegerOptional

Page offset

Default: 0

Responses

200

Successful Response

application/json

totalintegerRequired

limitintegerRequired

offsetintegerRequired

has_morebooleanRequired

404

Entity not found

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/audit/entity/{entity_id}/access-log

GET /v1/{workspace_id}/audit/entity/{entity_id}/access-log HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "events": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "text",
      "service": "text",
      "actor_entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "actor_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "action": "text",
      "resource_type": "text",
      "resource_id": "text",
      "resource_name": "text",
      "ip_address": "text",
      "user_agent": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "phi_accessed": false
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_more": true
}

Get Audit Summary

get

Audit summary statistics for compliance dashboard.

Permissions: admin, owner (Audit.view)

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

date_fromstring · date-time · nullableOptional

Start of date range

date_tostring · date-time · nullableOptional

End of date range

Responses

200

Successful Response

application/json

total_eventsintegerRequired

phi_access_eventsintegerRequired

unique_actorsintegerRequired

services_with_eventsintegerRequired

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/audit/summary

GET /v1/{workspace_id}/audit/summary HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_events": 1,
  "phi_access_events": 1,
  "unique_actors": 1,
  "services_with_events": 1
}

Create Audit Export

post

Export audit events to the UC Volume as NDJSON.

Returns a platform-api proxy download path (UC Volumes have no presigned URLs — download_audit_export streams the bytes).

Permissions: admin, owner

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

Body

date_fromstring · date-timeRequired

date_tostring · date-timeRequired

servicestring · max: 64 · nullableOptional

Filter by service name.

actionstring · max: 128 · nullableOptional

Filter by action type.

phi_onlybooleanOptionalDefault: false

Responses

200

Successful Response

application/json

export_idstringRequired

s3_keystringRequired

row_countintegerRequired

download_urlstringRequired

created_atstringRequired

422

Validation Error

application/json

429

Rate limited

post/v1/{workspace_id}/audit/export

POST /v1/{workspace_id}/audit/export HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "date_from": "2026-07-10T21:37:33.568Z",
  "date_to": "2026-07-10T21:37:33.568Z",
  "service": "text",
  "action": "text",
  "phi_only": false
}

{
  "export_id": "text",
  "s3_key": "text",
  "row_count": 1,
  "download_url": "text",
  "created_at": "text"
}

List Audit Exports

get

List past audit exports with platform-api proxy download paths.

Permissions: admin, owner

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

limitinteger · min: 1 · max: 200Optional

Max exports to return

Default: 50

Responses

200

Successful Response

application/json

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/audit/exports

GET /v1/{workspace_id}/audit/exports HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "exports": [
    {
      "key": "text",
      "size": 1,
      "last_modified": "text",
      "download_url": "text"
    }
  ]
}

Download Audit Export

get

Proxy-download an audit export artifact (NDJSON) from the UC Volume.

filename must be a bare export filename ({export_id}.ndjson); path separators and traversal sequences are rejected with 422. The volume key is reconstructed server-side as exports/{workspace_id}/{filename}, so a caller can never reach outside its own workspace prefix. The bytes are streamed volume→client without buffering the artifact in memory.

Permissions: admin, owner (Audit.export — same gate as create/list).

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

filenamestringRequired

Responses

200

The export artifact, streamed as NDJSON.

anyOptional

404

Audit export not found

422

Invalid export filename

429

Rate limited

get/v1/{workspace_id}/audit/exports/download/{filename}

GET /v1/{workspace_id}/audit/exports/download/{filename} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousCommand Center NextFunctions

Last updated 57 minutes ago

Was this helpful?