Hire an agent

Creates an agent from a template. If required settings are missing the answer is 422 MISSING_FIELDS with the fields to ask the user for; send the request again with them. Settings that let an agent act without review (auto-replies, autopilot, scheduling without approval, changes in connected tools) and setup-page-only fields return 422 SET_IN_APP with a link to finish in the Nimply app. Needs a workspace owner, admin or editor.

Authorization

api-key

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

templateId*string

Template id from GET /v1/agent-templates.

name?string

Defaults to the template (or preset) name.

channelIds?array<string>

Channel ids the agent works on. One channel unless the template is multiChannel.

preset?string

Preset key from the template.

config?

Setup values keyed by field key. Only askable fields; anything else returns 422 SET_IN_APP.

tags?array<string>

Your own labels (≤10).

Response Body

`application/json`

curl -X POST "https://example.com/v1/agents" \  -H "Content-Type: application/json" \  -d '{    "templateId": "linkedin-ghostwriter"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "LinkedIn Ghostwriter — Brewhaus",  "templateId": "linkedin-ghostwriter",  "templateName": "LinkedIn Ghostwriter",  "kind": "content",  "status": "ACTIVE",  "pausedReason": "CHANNEL_REMOVED",  "channelIds": [    "string"  ],  "preset": "carousel",  "config": {},  "setInApp": [    "string"  ],  "schedule": {    "cadence": "weekly",    "label": "Once a week"  },  "tags": [    "string"  ],  "createdAt": "string",  "updatedAt": "string",  "appUrl": "string"}

Empty

Authorization

Request Body

Response Body

201application/json

400

403

404

422

`application/json`