chats.chatDelegations

GET

/v1/chats/{chatId}/delegations

const url = 'https://example.com/v1/chats/example/delegations';
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/example/delegations \
  --header 'Authorization: Bearer <token>'

Lists the work that this Chat gave to Bots, with its status and result.

Authorizations

token
session

Parameters

Path Parameters

chatId

required

string

>= 1 characters

Responses

200

Success

application/json

Array<object>

object

required

string

>= 1 characters <= 128 characters

parent

required

object

chat

required

string

turn

string

toolCallId

string

trigger

string

>= 1 characters <= 128 characters

bot

required

string

>= 1 characters <= 128 characters

chat

required

Any of:

string
null

string

status

required

string

Allowed values: authorizing queued running paused completed failed cancelled

task

required

string

reason

string

result

required

Any of:

string
null

string

limits

object

timeMs

required

integer

>= 1000 <= 2592000000

steps

integer

>= 1 <= 9007199254740991

budgetMicros

integer

>= 1 <= 9007199254740991

usage

object

timeMs

required

number

steps

required

integer

>= -9007199254740991 <= 9007199254740991

costMicros

required

number

pause

object

limit

required

string

Allowed values: time steps budget

request

required

Any of:

string
null

string

>= 1 characters <= 128 characters

delegation

string

>= 1 characters <= 128 characters

required

number

createdAt

required

number

updatedAt

required

number

executionId

required

string

>= 1 characters <= 128 characters

executionStatus

required

string

Allowed values: queued running waiting cancelling completed failed cancelled interrupted outcome_unknown

failure

required

Any of:

object
null

object

errorId

required

string

>= 1 characters <= 128 characters

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

Example

[
  {
    "status": "authorizing",
    "pause": {
      "limit": "time"
    },
    "executionStatus": "queued",
    "failure": {
      "category": "invalid"
    }
  }
]

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

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ChatNotFound | ExecutionNotFound | DelegationNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ChatNotFound

chat

required

string

Example

{
  "_tag": "ChatNotFound"
}

409

ChatConflict | ExecutionConflict | ExecutionKeyConflict | DelegationConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

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 | ExecutionUnavailable | DelegationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ChatStorageUnavailable

Example

{
  "_tag": "ChatStorageUnavailable"
}