Skip to main content
GET
Returns execution metadata for one Fini-authored event in your workspace. Use this endpoint when a conversation export tells you which event to inspect, but you need the detailed trace behind that response: planning, knowledge search, answer reasoning, tag selection, executed Attributes, and executed Rules.
Use List conversations or Get conversation to discover event IDs. This route only returns metadata for events where role is finibot.
This public API route is currently registered as /v2/hc-events/{id}/metadata, without the /public suffix used by most other public endpoints. It still requires a workspace API key with read scope.

Headers

string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

Path parameters

string
required
Event ID to inspect. The event must belong to your workspace and have role: "finibot".

Response

object | null
Planning trace for the response, including reasoning and whether Fini decided to run knowledge search.
Knowledge-search trace, including top-result reasoning, selection reasoning, and the articles considered for the response.
object | null
Answer-generation reasoning items returned by the model trace.
object | null
Input tag-selection reasoning and chosen tags, when input tags were selected for the event.
object | null
Output tag-selection reasoning and chosen tags, when output tags were selected for the event.
array | null
Attribute executions exposed for this event, including tool names, success state, extracted data, and external API step results when available.
object | null
Rule execution details for the selected rule, including ruleId, ruleName, and node execution results when available.

Errors

The event ID is missing, or the event is not from the Fini bot. Only finibot events have this metadata response.
The API key is missing, malformed, revoked, or invalid. Confirm you are sending Authorization: Bearer fini_... with the full key.
The API key does not include the read scope required for this route.
The event does not exist or does not belong to the workspace tied to your API key.