Set an agent up
PUT
Creates the agent's setup, or replaces it. This is a full replacement rather than a merge, so send every field you want kept. It changes the setup your team sees in the app, and the next run uses it.
apiKeyheader
AuthorizationBearer <token>API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.
agentKey*stringWhich agent, such as changelog
Body
application/json- body
repository?stringA public GitHub repository as owner/name. A public one needs no connection.
Match
^[\w.-]+\/[\w.-]+$values?Settings keyed by the field keys from GET /v1/agents
deliverables?array<string>Which deliverables to make. A required one is always included.
The agent as it now stands
application/json- response
key*stringname*stringsummary*stringfields*array<>What this agent can be configured with
deliverables*array<>installed*booleansetup*|Null until it is set up
curl -X PUT "https://example.com/v1/agents/string" \ -H "Content-Type: application/json" \ -d '{}'{ "key": "string", "name": "string", "summary": "string", "fields": [ { "key": "string", "label": "string", "type": "string", "required": true, "helperText": "string" } ], "deliverables": [ { "key": "string", "label": "string", "required": true } ], "installed": true, "setup": { "repository": "string", "values": { "property1": null, "property2": null }, "deliverables": [ "string" ] }}