Skip to content
OpenBot

requests.listRequests

GET
/v1/requests
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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: pending allowed denied expired cancelled

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
string
agent
required
string
>= 1 characters <= 128 characters
capability
required
object
action
required
string
Allowed values: tools.call apps.call agents.spawn agents.delegate
target
required
string
<= 512 characters
arguments
object
reason
required
string
approver
required
Any of:
object
_tag
required
string
Allowed values: Person
userId
required
string
chain
required
Array<string>
session
required
string
turn
required
string
toolCallId
required
string
app
object
id
required
string
session
required
string
turn
required
string
callId
required
string
toolName
required
string
source
required
object
connectionId
required
string
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:
Any of:
object
_tag
required
string
Allowed values: Completed
source
required
object
connectionId
required
string
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
endorsements
required
Array<object>
object
agent
required
string
>= 1 characters <= 128 characters
scope
required
string
Allowed values: once session lifetime
reason
string
status
required
string
Allowed values: pending allowed denied expired cancelled
decision
required
Any of:
object
by
required
Any of:
object
_tag
required
string
Allowed values: Person
userId
required
string
scope
string
Allowed values: once session lifetime
reason
string
question
string
at
required
number
revision
required
integer
<= 9007199254740991
createdAt
required
number
expiresAt
required
number

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"
    }
  }
]

400

Section titled “400”

AgentInvalid | OrganizationRequired

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

Example 

{
  "_tag": "AgentInvalid"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

AgentNotFound | RequestNotFound

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

Example 

{
  "_tag": "AgentNotFound"
}

409

Section titled “409”

AgentConflict | RequestConflict

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

Example 

{
  "_tag": "AgentConflict"
}

503

Section titled “503”

AuthorizationUnavailable | AgentStorageUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "AuthorizationUnavailable"
}