Skip to main content
POST
/
agents
Create Agent Key
curl --request POST \
  --url https://use.hoop.dev/api/agents \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "default",
  "mode": "standard"
}
'
{
  "token": "grpc://default:xagt-zKQQA9PAjCVJ4O8VlE2QZScNEbfmFisg_OerkI21NEg@127.0.0.1:8010?mode=standard"
}

Body

application/json

The request body resource

​
name
string
required

Unique name of the resource

Example:

"default"

​
mode
enum<string>
default:standard

Mode of execution of the agent

  • standard - Is the default mode, which is suitable to run the agent as a standalone process
  • embedded - This mode is suitable when the agent needs to be run close to another process or application
Available options:
standard,
embedded

Response

Created

​
token
string

Token is the key in a DSN format: grpc|grpcs://:@:?mode=standard|embedded

Example:

"grpc://default:xagt-zKQQA9PAjCVJ4O8VlE2QZScNEbfmFisg_OerkI21NEg@127.0.0.1:8010?mode=standard"