Skip to content
Last updated

Resolve a chat artifact ref by entity

Resolve the chat artifact ref for an underlying artifact entity (document, presentation, spreadsheet, dashboard). Clients use this to mount the side pane for an artifact opened from a chip or deep-link, after verifying the caller can read the underlying entity.

GEThttps://api.aitronos.com/v1/chat-artifacts/refs/by-entity/{smoc_entity_id}

Looks up the chat artifact ref by the underlying entity ID. When no ref row exists yet — for example, the artifact was created outside the chat-artifacts flow or fetched directly by the agent — a transient ref descriptor is returned whose ref_id carries a transient_ marker.

Path parameters

smoc_entity_id string required

Identifier of the underlying artifact entity (the item ID). The ref's type is resolved from the entity.

Returns

A ChatArtifactRefByEntityResponse object with a single ref field:

FieldTypeDescription
ref_idstringThe chat artifact ref ID. Carries a transient_ marker when no persisted ref exists yet.
smoc_entity_typestringEntity type (document, presentation, spreadsheet, dashboard).
smoc_entity_idstringThe underlying entity ID (echoed).
titlestringCurrent title of the entity.
created_atstringISO-8601 creation timestamp.
thread_idstring | nullThread the ref was first created in, if any.
message_idstring | nullMessage the ref was first created in, if any.
cURL
curl -X GET "https://api.aitronos.com/v1/chat-artifacts/refs/by-entity/itm_revenue_plan" \
  -H "X-API-Key: $FREDDY_API_KEY"