chats.listChats

GET

/v1/chats

const url = 'https://example.com/v1/chats?kind=direct';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/chats?kind=direct' \
  --header 'Authorization: Bearer <token>'

Lists your Chats. Without kind, it lists direct Chats, channel Chats and live Chats.

Authorizations

token
session

Parameters

Query Parameters

bot

string

>= 1 characters <= 128 characters

kind

string

Allowed values: direct channel task review live

Responses

200

Success

application/json

Array<object>

object

chat

required

object

required

string

revision

required

integer

<= 9007199254740991

kind

required

string

Allowed values: direct channel task review live

bot

required

string

>= 1 characters <= 128 characters

parent

required

Any of:

object
null

object

chat

required

string

delegation

required

string

>= 1 characters <= 128 characters

title

string

settings

required

object

mode

required

string

Allowed values: build plan

model

object

_tag

required

string

Allowed values: Config.Selection

provider

required

string

model

required

string

reasoningEffort

Any of:

string
null

string

serviceTier

Any of:

string
null

string

planApproval

object

approver

required

string

Allowed values: chain person

timeoutMs

required

integer

>= 1000 <= 604800000

onTimeout

required

string

Allowed values: run stay

createdAt

required

number

status

required

string

Allowed values: Idle Running Completed Failed Interrupted

turn

required

Any of:

string
null

string

response

required

Any of:

object
null

object

required

string

created_at

required

integer

<= 9007199254740991

status

required

string

Allowed values: in_progress completed incomplete failed cancelled

executionId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

Example

[
  {
    "chat": {
      "kind": "direct",
      "settings": {
        "mode": "build",
        "model": {
          "_tag": "Config.Selection"
        }
      },
      "planApproval": {
        "approver": "chain",
        "onTimeout": "run"
      }
    },
    "status": "Idle",
    "response": {
      "status": "in_progress"
    }
  }
]

400

ChatModelInvalid | OrganizationRequired

application/json

Any of:

object
object

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

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

ChatNotFound

application/json

object

_tag

required

string

Allowed values: ChatNotFound

chat

required

string

Example

{
  "_tag": "ChatNotFound"
}

409

ChatConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChatConflict

message

required

string

Example

{
  "_tag": "ChatConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ChatStorageUnavailable

Example

{
  "_tag": "ChatStorageUnavailable"
}