Skip to content
OpenBot

chats.chatItems

GET
/v1/chats/{chatId}/items
curl --request GET \
  --url https://example.com/v1/chats/example/items \
  --header 'Authorization: Bearer <token>'

Lists the Items of the Chat, newest first. Send next as before to read older Items.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
chatId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters”
before
string
limit
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
content
required
origin
object
chat
required
string
turn
required
string
step
required
integer
<= 9007199254740991
notice
object
kind
required
string
>= 1 characters
ref
string
seq
required
integer
<= 9007199254740991
next
required
Any of:
integer
<= 9007199254740991

Example generated

{
  "items": [
    {
      "id": "example",
      "content": "example",
      "origin": {
        "chat": "example",
        "turn": "example",
        "step": 1,
        "notice": {
          "kind": "example",
          "ref": "example"
        }
      },
      "seq": 1
    }
  ],
  "next": 1
}

400

Section titled “400”

ChatModelInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatModelInvalid
reason
required
string
Allowed values: provider-not-found model-not-found unsupported-option missing
message
required
string

Example 

{
  "_tag": "ChatModelInvalid",
  "reason": "provider-not-found"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

ChatNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ChatNotFound
chat
required
string

Example 

{
  "_tag": "ChatNotFound"
}

409

Section titled “409”

ChatConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatConflict
message
required
string

Example 

{
  "_tag": "ChatConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChatStorageUnavailable

Example 

{
  "_tag": "ChatStorageUnavailable"
}