requests.listRequests

GET

/v1/requests

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

Lists the requests that wait for the caller, or that the caller answered.

Authorizations

token
session

Parameters

Query Parameters

status

string

Allowed values: pending allowed denied expired cancelled

Responses

200

Success

application/json

Array<object>

object

required

string

>= 1 characters <= 128 characters

bot

required

string

>= 1 characters <= 128 characters

capability

required

object

action

required

string

Allowed values: tools.call apps.call bots.create bots.delegate plans.run channels.send delegations.continue computers.acquire computers.create computers.delete computers.expose

target

required

string

<= 512 characters

arguments

object

reason

required

string

approver

required

Any of:

object
object

object

_tag

required

string

Allowed values: Person

userId

required

string

chain

required

Array<string>

chat

required

string

turn

required

string

toolCallId

required

string

app

object

required

string

>= 1 characters <= 128 characters

chat

required

string

turn

required

string

callId

required

string

toolName

required

string

source

required

object

connectionId

required

string

>= 1 characters <= 128 characters

connectionName

required

string

cardUrl

required

string

appName

required

string

remoteIndex

required

integer

<= 9007199254740991

revision

required

integer

<= 9007199254740991

kind

required

string

Allowed values: tool resource template prompt

name

required

string

definition

arguments

required

object

readOnly

required

boolean

round

required

integer

<= 9007199254740991

status

required

string

Allowed values: PendingApproval Approved Rejected Sending InputRequired Completed Failed OutcomeUnknown

result

required

Any of:

object

_tag

required

string

Allowed values: Completed

source

required

object

connectionId

required

string

>= 1 characters <= 128 characters

connectionName

required

string

cardUrl

required

string

appName

required

string

remoteIndex

required

integer

<= 9007199254740991

revision

required

integer

<= 9007199254740991

kind

required

string

Allowed values: tool resource template prompt

name

required

string

definition

result

required

operationId

string

>= 1 characters <= 128 characters

code

object

run

required

string

>= 1 characters <= 128 characters

index

required

integer

<= 9007199254740991

code

required

string

endorsements

required

Array<object>

object

bot

required

string

>= 1 characters <= 128 characters

scope

required

string

Allowed values: once chat lifetime

reason

string

status

required

string

Allowed values: pending allowed denied expired cancelled

decision

required

Any of:

object
null

object

required

Any of:

object

_tag

required

string

Allowed values: Person

userId

required

string

scope

string

Allowed values: once chat lifetime

reason

string

question

string

required

number

revision

required

integer

<= 9007199254740991

createdAt

required

number

expiresAt

required

number

onExpire

string

Allowed values: allow deny

executionId

required

string

>= 1 characters <= 128 characters

executionStatus

required

string

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

Example

[
  {
    "capability": {
      "action": "tools.call"
    },
    "approver": {
      "_tag": "Person"
    },
    "app": {
      "source": {
        "kind": "tool"
      },
      "status": "PendingApproval",
      "result": {
        "_tag": "Completed",
        "source": {
          "kind": "tool"
        }
      }
    },
    "endorsements": [
      {
        "scope": "once"
      }
    ],
    "status": "pending",
    "decision": {
      "by": {
        "_tag": "Person"
      },
      "scope": "once"
    },
    "onExpire": "allow",
    "executionStatus": "queued"
  }
]

400

BotInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | 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

BotNotFound | ExecutionNotFound | RequestNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict | ExecutionConflict | ExecutionKeyConflict | RequestConflict

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}