Chat

List chat sessions.

get/chats

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/chats/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

offsetinteger

How many chat sessions to skip before returning.

limitinteger

How many chat sessions to return.

Response

Successful operation

idstring required

namestring

collection_idstring

collection_namestring

prompt_template_idstring

latest_message_contentstring

updated_atstring date-time required

workspacestring

status'active' | 'expiring' | 'archived'

Status of the chat session

expiry_datestring date-time

An expiry date for the chat session

inactivity_intervalinteger

Inactivity interval in days

keep_foreverboolean

Whether the chat session is preserved from auto-archival

usernamestring

Username of the session owner.

archived_atstring date-time

Timestamp when the chat session was archived

source'user' | 'schedule'

How the session was created — 'user' for user-initiated, 'schedule' for scheduled-task-triggered.

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Discussion about sci-fi heroes.",
    "collection_id": "c91e7c84-65df-4b43-ba15-fbd3afb2e86f",
    "prompt_template_id": "4e400991-c459-455f-995c-dc6f55ffdb90",
    "latest_message_content": "The strongest hero is superman!",
    "status": "active"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.