API ReferenceAgents

Create an agent

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

environmentIdstringRequired
Environment ID

Request

This endpoint expects an object.
topicslist of enumsOptional
The topics the agent should listen for
compilerenumOptional
The compiler of the agent
Allowed values:
sourcestringOptional
The source of the agent
sourceMapstringOptional
The source map of the agent
slugstringOptional
The slug of the agent
templateenumOptional

The template of the agent; Template options are required for templated agents.

templateOptionsobjectOptional

The options for a templated agent. Must be provided if template is provided.

isSystembooleanOptional
Whether the agent is a system agent. This should be false for all agents created by users.
namespacestringOptional
The namespace this agent should be limited to. Right now, this is information only and not used to actually filter agents that run, so you must still specify the namespace filter in the agent code.
packageVersionsmap from strings to stringsOptional
Package versions information for the agent
commitInfomap from strings to anyOptional
Commit information for the agent
optionsmap from strings to anyOptionalDeprecated

This field is deprecated and will be removed in the future. Use the template and templateOptions fields instead.

Response

This endpoint returns an object.
dataobject or null

Errors