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

Authorizations

​
X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

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".