Get Surface Provenance

GetSurfaceProvenance returns, in plain terms, what the surface’s report was built from: every record its program touched, in the order it touched them.

GET /api/v1/a2ui/conversations/{conversation_id}/surfaces/{surface_id}/provenance

Get Surface Provenance

cURL

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/a2ui/conversations/{conversation_id}/surfaces/{surface_id}/provenance \
  --header 'Authorization: Bearer <token>'

200

{
  "programCommitId": "<string>",
  "programFunctionId": "<string>",
  "programInput": "<string>",
  "programInvocationId": "<string>",
  "programSource": "<string>",
  "sources": [
    {
      "componentId": "<string>",
      "count": "<string>",
      "kind": "<string>",
      "label": "<string>",
      "matchedToolCall": "<string>",
      "ref": "<string>",
      "verified": true
    }
  ],
  "stepObjectsVisible": true,
  "steps": [
    {
      "objects": [
        {
          "displayName": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "stepsAvailable": true,
  "toolCalls": [
    {
      "calledAt": "2023-11-07T05:31:56Z",
      "inputDigest": "<string>",
      "toolName": "<string>"
    }
  ],
  "transcriptAvailable": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

conversation_id · string · required

The conversationId field.

surface_id · string · required

The surfaceId field.

Response

200 - application/json

A2UIServiceGetSurfaceProvenanceResponse returns what a surface was built from: the steps its program ran, and the sources its components report.

A2UIServiceGetSurfaceProvenanceResponse returns what a surface was built from: the steps its program ran, and the sources its components report.

programCommitId · string

The program's identity: code mode invokes by explicit commit, so the commit — not the function — is what a refresh re-executes.

programFunctionId · string

The program that produced a reporting surface. Flat rather than a nested ref: these five fields are read together by one drawer and nothing else, and a saved report's ProgramRef is the type worth converging on later. All empty for a surface carrying no report components, and for reports emitted before the report-program requirement was enabled for the tenant.

programInput · string

The JSON parameters the program ran with. Empty when the invocation has aged out of retention.

programInvocationId · string

The run that produced this surface.

programSource · string

The program's source, read from the pinned commit. Empty when the commit has aged out of code-mode retention — the report still renders, but what produced it is no longer recoverable.

sources · A 2 Ui Provenance Source · object[] | null

The sources field.

Show child attributes

stepObjectsVisible · boolean

Whether the caller may see the ids each step named. False withholds every A2UIProvenanceStep.objects on the same boundary that withholds program_source: those ids are the program's parameters by another name.

steps · A 2 Ui Provenance Step · object[] | null

Everything the surface's program did, in the order it does it.

Show child attributes

stepsAvailable · boolean

False when neither the pinned program nor the conversation transcript could be read, so no record of what was looked at survives. Distinguishes that from a record that was read and genuinely contains no steps.

toolCalls · A 2 Ui Provenance Tool Call · object[] | null · deprecated

Deprecated: raw tool names, superseded by steps. Still populated for clients on the previous shape.

Show child attributes

transcriptAvailable · boolean

False when the backing session or its transcript steps are gone.