POST
/
agents
/
{agentId}
/
analyze
/
text
curl --request POST \
  --url https://gardianai.com/api/v1/agents/{agentId}/analyze/text \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "content": "I don'\''t like your products"
}'
{
  "agent_id": "66683c760ea17e1c58a16649",
  "agent_name": "Sentiment",
  "content": "I don't like your products",
  "label": "negative",
  "score": 0.98,
  "label_scores": {
    "positive": 0,
    "neutral": 0,
    "negative": 0.98
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agentId
string
required

The ID of the agent to send feedback to.

Body

application/json
​
content
string

The text you'd like to analyze. Limit 1000 characters.

Maximum length: 1000
Example:

"I don't like your products"

Response

200 - application/json
Successful response
​
agent_id
string

ID of the agent that performs the analysis.

Example:

"66683c760ea17e1c58a16649"

​
agent_name
string

Name of the agent that performs the analysis.

Example:

"Sentiment"

​
content
string

Content sent for analysis.

Example:

"I don't like your products"

​
label
string

The label with the highest probability. This will always be the label with the highest score.

Example:

"negative"

​
score
number

The label score, ranging from 0 to 1, with 1 indicating a high probability of being correct.

Example:

0.98

​
label_scores
object

An object that includes the scores for all labels.

Example:
{
  "positive": 0,
  "neutral": 0,
  "negative": 0.98
}