Conversation
Public metadata for a Genie One conversation.
Conversation object
Public metadata for a Genie One conversation.
- conversation_idstringBetaOutput only
The conversation identifier.
- titlestringBetaOutput only
The current conversation title.
- create_timestringBetaOutput only
The creation time as an RFC 3339 timestamp.
- update_timestringBetaOutput only
The last update time as an RFC 3339 timestamp.
- statusstringBetaOutput only
The lifecycle status of the latest response, when available. This field can be omitted.
List conversations Beta
GET
Lists the caller's Genie One conversations, ordered by most recent update.
Parameters
- page_sizeint32query
The maximum number of conversations to return. A value of
0uses the default of 20. Values above 100 are capped at 100; negative values are rejected.
- page_tokenstringquery
The opaque
next_page_tokenfrom the previous page. Omit for the first page.
Response
Returns a list of Conversation objects. next_page_token
appears only when another page is available.
This example uses page_size=1 and has another page.
Get a conversation Beta
GET
Gets metadata for a Genie One conversation owned by the caller, without its items.
API scopes: genie
Parameters
- conversation_idstringRequiredpath
The conversation to retrieve. Use the ID from
response.createdor List conversations.
Response
Returns the Conversation object.
create_time and update_time are RFC 3339 timestamps. The response does not
include conversation items.
Delete a conversation Beta
DELETE
Deletes a Genie One conversation owned by the caller.
Parameters
- conversation_idstringRequiredpath
The conversation to delete.
List conversation items Beta
GET
Lists public user and assistant messages in a conversation. This endpoint is
available when Genie One conversation history is enabled for the workspace.
Pass a page's next_page_token as page_token to request the next page.
Parameters
- conversation_idstringRequiredpath
The conversation whose public items are returned.
- page_sizeint32query
The maximum number of items to return.
- page_tokenstringquery
The opaque
next_page_tokenfrom the previous page. Omit for the first page.
Response
- objectstringOutput only
Always
list.
- dataarray of objectOutput only
The public messages in this page.
Show child attributesHide child attributes
- typestringOutput only
The item discriminator,
message.
- idstringOutput only
The opaque item identifier. Clients must not parse or derive identifiers from it.
- rolestringOutput only
The message role:
userorassistant.
- contentarray of objectOutput only
The ordered text parts of the message.
Show child attributesHide child attributes
- typestringOutput only
input_textfor user messages, oroutput_textfor assistant messages.
- textstringOutput only
The text of this content part. Output text may contain Markdown, including result tables.
- annotationsarray of objectOutput only
Public source references used by assistant text. User input has no annotations.
Show child attributesHide child attributes
- typestringOutput only
The citation discriminator,
asset.
- titlestringOutput only
The customer-visible source title.
- asset_typestringOutput only
The kind of cited source, such as
TABLE,NOTEBOOK, orWEB.
- identifierstringOutput only
The public asset identifier, volume path, or source web URL.
- indexint32Output only
The one-based citation number. It is neither a character offset nor an index into
annotations. Numbers remain stable if unsupported citations are omitted.
- statusstringOutput only
The lifecycle status of this message, when available.
- phasestringOutput only
Assistant message phase:
commentaryorfinal_answer. Omitted for user messages.
- create_timestringOutput only
The message creation time as an RFC 3339 timestamp, when available.
- complete_timestringOutput only
The message completion time as an RFC 3339 timestamp, when available.
- response_idstringOutput only
The response associated with this history item, when available.
- next_page_tokenstringOutput only
Present only when another page is available. Pass it as
page_tokento continue.
This example uses page_size=2 and has another page.