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
chevron-right
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_idany ofRequired
string · uuidOptional
or
nullOptional
target_entity_idstring · uuidRequired
target_entity_typestring · enumRequiredPossible values:
content_mdany ofOptional
string · max: 20000Optional
or
nullOptional
content_jsonany ofRequired
or
nullOptional
versionany ofOptional
string · max: 64Optional
or
nullOptional
evidence_event_idsstring · uuid[] · max: 500Optional
confidencenumber · max: 1Required
event_countintegerRequired
model_nameany ofOptional
string · max: 128Optional
or
nullOptional
truncatedbooleanOptionalDefault: false
generated_atany ofRequired
string · date-timeOptional
or
nullOptional
get
/v1/{workspace_id}/entities/{entity_id}/brief

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
chevron-right
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_idany ofRequired
string · uuidOptional
or
nullOptional
target_entity_idstring · uuidRequired
target_entity_typestring · enumRequiredPossible values:
content_mdany ofOptional
string · max: 20000Optional
or
nullOptional
content_jsonany ofRequired
or
nullOptional
versionany ofOptional
string · max: 64Optional
or
nullOptional
evidence_event_idsstring · uuid[] · max: 500Optional
confidencenumber · max: 1Required
event_countintegerRequired
model_nameany ofOptional
string · max: 128Optional
or
nullOptional
truncatedbooleanOptionalDefault: false
generated_atany ofRequired
string · date-timeOptional
or
nullOptional
post
/v1/{workspace_id}/entities/{entity_id}/brief

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
chevron-right
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_idany ofRequired
string · uuidOptional
or
nullOptional
target_entity_idstring · uuidRequired
target_entity_typestring · enumRequiredPossible values:
content_mdany ofOptional
string · max: 20000Optional
or
nullOptional
content_jsonany ofRequired
or
nullOptional
versionany ofOptional
string · max: 64Optional
or
nullOptional
evidence_event_idsstring · uuid[] · max: 500Optional
confidencenumber · max: 1Required
event_countintegerRequired
model_nameany ofOptional
string · max: 128Optional
or
nullOptional
truncatedbooleanOptionalDefault: false
generated_atany ofRequired
string · date-timeOptional
or
nullOptional
get
/v1/{workspace_id}/brief
200

Successful Response

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
chevron-right
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_idany ofRequired
string · uuidOptional
or
nullOptional
target_entity_idstring · uuidRequired
target_entity_typestring · enumRequiredPossible values:
content_mdany ofOptional
string · max: 20000Optional
or
nullOptional
content_jsonany ofRequired
or
nullOptional
versionany ofOptional
string · max: 64Optional
or
nullOptional
evidence_event_idsstring · uuid[] · max: 500Optional
confidencenumber · max: 1Required
event_countintegerRequired
model_nameany ofOptional
string · max: 128Optional
or
nullOptional
truncatedbooleanOptionalDefault: false
generated_atany ofRequired
string · date-timeOptional
or
nullOptional
post
/v1/{workspace_id}/brief
200

Successful Response

Last updated

Was this helpful?