Skip to main content
GET
/
agent-request
/
{agentRequestId}
Get agent request
curl --request GET \
  --url https://api.joinslash.com/agent-request/{agentRequestId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "status": "pending",
  "display": {
    "title": "<string>",
    "sections": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "description": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "result": {}
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

agentRequestId
string
required

The unique identifier of the agent request (returned in x-deferred-action-id header)

Response

OK

A pending or completed agent request

id
string
required

Unique identifier for the agent request

status
enum<string>
required

Current status of the request

Available options:
pending,
approved,
rejected,
expired,
executed,
failed,
running
display
object
required

Human-readable display information

createdAt
string<date-time>
required

When the request was created

result
object

The result of the executed action. Only present when status is "executed".