Sign in

Changed on
get/api/v1beta/me/recent_chats

Request

  • The document declares no server URL.
  • Auth: bearer_auth (a scheme the document does not define)

Query parameters

limitinteger

Maximum number of chats to return per page. Defaults to 30 if not provided. Larger values may impact performance.

offsetinteger

Number of chats to skip for pagination. Defaults to 0 if not provided.

include_archivedboolean

Whether to include archived chats in results. Defaults to false if not provided.

qstring

Optional full-text search query for chat titles. User-provided titles take precedence over generated summary titles. Empty values are treated like an unfiltered recent chats list.

pinnedboolean

If provided, filter chats by their pinned state.

type'chat' | 'assistant'

Kind of chat to restrict a recent chat listing to.

If provided, only return chats of the given kind: chat for chats without an assistant, assistant for assistant-based chats.

include_delegatedboolean

Whether to include delegated runs (chats spawned by in-chat delegation). Defaults to false; delegated runs are hidden from listings unless requested.

origin_chat_idstring uuid

If provided, only return chats spawned from this origin chat. Composes with include_delegated rather than overriding it, so listing a chat's delegated runs requires passing both.

created_viastring

Comma-separated ChatCreatedVia values. If provided, only return chats created via one of these surfaces.

exclude_created_viastring

Comma-separated ChatCreatedVia values. Chats created via one of these surfaces are left out. Composes with created_via.

Response

Successfully retrieved chats with pagination metadata

Example response

{
  "chats": [
    {
      "delegated_run_outcome": "completed",
      "provenance_run_mode": "background"
    }
  ]
}

Changes

  • 70d280a4fc70Revision changes
    • info

      added the new optional query request parameter created_via

    • info

      added the new optional query request parameter exclude_created_via

    • info

      added the required property // to the response with the status

  • baa8e1e150bcRevision changes
    • info

      added the optional property // to the response with the status