Get Agent Context

Retrieves the content of the agent context.

This action is available in API version 67.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getAgentContext

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`contextDescription`	string	Optional. A description of the agent context.

Outputs

Output	Type	Description
`agentContextApex`	string	Specifies the agent context as an Apex object. This output is an Apex output type that contains nested arrays in JSON format.

Example

Sample request body:

1{
2  "inputs" : [{
3    "contextDescription" : "Sample agent context description."
4  }]
5}

Sample response body:

1{
2  "actionName" : "getAgentContext",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "agentContextApex" : {
7      "contextDescription" : "Sample agent context description.",
8      "contextId" : "0XxRZ0000008iPeYAI",
9      "content" : "Sample agent context content."
10    }
11  }
12}