Self Image

Get Latest Brief

get

Return the latest Self-Image brief for the target entity (null shape if none).

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

Target entity UUID

Responses

200

Successful Response

application/json

Wire shape for a Self-Image brief.

event_id is null when no brief has ever been generated for the entity. All other fields are nullable in that case so the UI can render a consistent empty state.

event_idstring · uuid · nullableRequired

target_entity_idstring · uuidRequired

target_entity_typestring · enumRequiredPossible values:

content_mdstring · max: 20000 · nullableOptional

versionstring · max: 64 · nullableOptional

evidence_event_idsstring · uuid[] · max: 500Optional

confidencenumber · max: 1Required

event_countintegerRequired

model_namestring · max: 128 · nullableOptional

truncatedbooleanOptionalDefault: false

generated_atstring · date-time · nullableRequired

422

Validation Error

application/json

get/v1/{workspace_id}/entities/{entity_id}/brief

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

{
  "event_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_type": "patient",
  "content_md": "text",
  "content_json": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "version": "text",
  "evidence_event_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "confidence": 1,
  "event_count": 1,
  "model_name": "text",
  "truncated": false,
  "generated_at": "2026-01-01T00:00:00.000Z"
}

Generate Brief

post

Generate a Self-Image brief for the target entity (patient, cohort, territory, emirate, or district).

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

Target entity UUID

Responses

200

Successful Response

application/json

Wire shape for a Self-Image brief.

event_id is null when no brief has ever been generated for the entity. All other fields are nullable in that case so the UI can render a consistent empty state.

event_idstring · uuid · nullableRequired

target_entity_idstring · uuidRequired

target_entity_typestring · enumRequiredPossible values:

content_mdstring · max: 20000 · nullableOptional

versionstring · max: 64 · nullableOptional

evidence_event_idsstring · uuid[] · max: 500Optional

confidencenumber · max: 1Required

event_countintegerRequired

model_namestring · max: 128 · nullableOptional

truncatedbooleanOptionalDefault: false

generated_atstring · date-time · nullableRequired

422

Validation Error

application/json

post/v1/{workspace_id}/entities/{entity_id}/brief

POST /v1/{workspace_id}/entities/{entity_id}/brief HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "event_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_type": "patient",
  "content_md": "text",
  "content_json": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "version": "text",
  "evidence_event_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "confidence": 1,
  "event_count": 1,
  "model_name": "text",
  "truncated": false,
  "generated_at": "2026-01-01T00:00:00.000Z"
}

Get Latest Workspace Brief

get

Return the latest workspace-level Self-Image brief (null shape if none).

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

Responses

200

Successful Response

application/json

Wire shape for a Self-Image brief.

event_id is null when no brief has ever been generated for the entity. All other fields are nullable in that case so the UI can render a consistent empty state.

event_idstring · uuid · nullableRequired

target_entity_idstring · uuidRequired

target_entity_typestring · enumRequiredPossible values:

content_mdstring · max: 20000 · nullableOptional

versionstring · max: 64 · nullableOptional

evidence_event_idsstring · uuid[] · max: 500Optional

confidencenumber · max: 1Required

event_countintegerRequired

model_namestring · max: 128 · nullableOptional

truncatedbooleanOptionalDefault: false

generated_atstring · date-time · nullableRequired

get/v1/{workspace_id}/brief

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

200

Successful Response

{
  "event_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_type": "patient",
  "content_md": "text",
  "content_json": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "version": "text",
  "evidence_event_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "confidence": 1,
  "event_count": 1,
  "model_name": "text",
  "truncated": false,
  "generated_at": "2026-01-01T00:00:00.000Z"
}

Generate Workspace Brief

post

Generate a workspace-level Self-Image brief (Opus 4.7).

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

Responses

200

Successful Response

application/json

Wire shape for a Self-Image brief.

event_id is null when no brief has ever been generated for the entity. All other fields are nullable in that case so the UI can render a consistent empty state.

event_idstring · uuid · nullableRequired

target_entity_idstring · uuidRequired

target_entity_typestring · enumRequiredPossible values:

content_mdstring · max: 20000 · nullableOptional

versionstring · max: 64 · nullableOptional

evidence_event_idsstring · uuid[] · max: 500Optional

confidencenumber · max: 1Required

event_countintegerRequired

model_namestring · max: 128 · nullableOptional

truncatedbooleanOptionalDefault: false

generated_atstring · date-time · nullableRequired

post/v1/{workspace_id}/brief

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

200

Successful Response

{
  "event_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "target_entity_type": "patient",
  "content_md": "text",
  "content_json": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "version": "text",
  "evidence_event_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "confidence": 1,
  "event_count": 1,
  "model_name": "text",
  "truncated": false,
  "generated_at": "2026-01-01T00:00:00.000Z"
}