Skip to main content
GET
/
v1
/
threads
Error
A valid request URL is required to generate request examples
{
  "threads": [
    {
      "id": "<string>",
      "title": "<string>",
      "resourceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "page": 123,
  "perPage": 123,
  "total": 123,
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Org API key (scopes the request to its organization) or the shared trusted key (requires X-Organization-Id on every request).

Headers

​
X-Organization-Id
string

Organization to scope the request to. Optional when authenticating with an org API key (the org is taken from the key; if sent, it must match). Required when authenticating with the trusted key.

​
X-User-Id
string

End-user identity for the request; user-scoped data (threads, memory) resolves to {orgId}_{userId}. Required by endpoints that read or write user-scoped resources. A userId query param (or body field, where documented) is accepted as a fallback.

Query Parameters

​
page
number
default:1

Page number (default 1)

Required range: x >= 1
​
perPage
number
default:20

Items per page (default 20, max 100)

Required range: 1 <= x <= 100
​
orderBy
enum<string>
default:updatedAt

Field to order by: createdAt or updatedAt (default updatedAt)

Available options:
createdAt,
updatedAt
​
order
enum<string>
default:desc

Sort order: asc or desc (default desc)

Available options:
asc,
desc
​
threadId
string

Filter by specific thread ID

Response

Paginated list of threads

​
threads
object[]
​
page
number
​
perPage
number
​
total
number
​
hasMore
boolean