> ## Documentation Index > Fetch the complete documentation index at: https://agents.nanonets.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update agent > Hot-patch the agent in place — changes are live immediately on the next run. No new version is created. Use `system_prompt` for the common case of just editing the prompt; use `config` to replace the entire configuration object. ## OpenAPI ````yaml PATCH /api/v1/agents/{agent_id} openapi: 3.1.0 info: title: Nanonets Agents Platform — Public API version: 1.0.0 summary: >- Programmatically run AI agents, send follow-up messages, fetch results, and update agent prompts. description: > The Nanonets Agents Platform Public API lets you trigger agents, stream task progress, and integrate agent outputs into your own systems. ## Authentication All requests must include a workspace API key as a Bearer token: ``` Authorization: Bearer YOUR_API_KEY ``` Workspace API keys are minted from the web app under **Settings → API Keys**. Each key is scoped to a single workspace; requests against agents or tasks outside that workspace return `403`. ## Lifecycle A typical integration is three calls: 1. `POST /v1/agents/{agent_id}/run` — start a task. Returns a `task_id` immediately. 2. Poll `GET /v1/tasks/{task_id}` until `status` is a terminal value (`completed`, `failed`, or `stopped`), **or** wait until it reaches `waiting_for_input` to respond with `POST /v1/tasks/{task_id}/message`. 3. `GET /v1/tasks/{task_id}/summary` for the final answer, or `/result` for the full reasoning trace. ## Errors Every error response is `{"error": ""}`. The HTTP status indicates the class: | Status | Meaning | |--------|---------| | 400 | Malformed request (bad UUID, missing required field, file too large) | | 401 | Missing or invalid API key | | 403 | API key is valid but the agent/task belongs to a different workspace | | 404 | Agent or task not found | | 500 | Server error — safe to retry with backoff | contact: name: Nanonets Support url: https://nanonets.com/support license: name: Proprietary servers: - url: https://agents.nanonets.com description: Production security: - bearerAuth: [] tags: - name: Agents description: Manage agents — create, list, update, run, and version. - name: Tasks description: >- Inspect task status, fetch results, list and cancel tasks, and send follow-up messages. paths: /api/v1/agents/{agent_id}: patch: tags: - Agents summary: Update an agent description: > Hot-patch the agent in place — changes are live immediately on the next run. No new version is created. Use `system_prompt` for the common case of just editing the prompt; use `config` to replace the entire configuration object. operationId: updateAgent parameters: - $ref: '#/components/parameters/AgentIdPath' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAgentRequest' responses: '200': description: Updated agent. content: application/json: schema: $ref: '#/components/schemas/Agent' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: parameters: AgentIdPath: name: agent_id in: path required: true description: UUID of the agent. schema: type: string format: uuid schemas: UpdateAgentRequest: type: object description: > Partial update. Provide only the fields you want to change. Hot-patched in place — no new version is created. properties: name: type: string system_prompt: type: string description: >- Convenience field — overwrites `config.system_prompt` while leaving other config keys untouched. config: type: object additionalProperties: true description: > **Replaces** the entire config object. To make a targeted change to one field, use `system_prompt` (for the prompt) or `GET` first and `PATCH` back the merged object. is_active: type: boolean Agent: type: object description: Full agent representation. required: - id - agent_group_id - version_number - status - name - config - is_active - created_at - updated_at properties: id: type: string format: uuid description: ID of this specific version of the agent. agent_group_id: type: string format: uuid description: > Stable identifier across all versions of this agent. Use this when you need to refer to "the agent" as a logical entity rather than a specific version. version_number: type: integer description: Sequential version number (1, 2, 3 …) within this agent group. status: $ref: '#/components/schemas/AgentStatus' name: type: string config: description: > Full agent configuration object. Free-form JSON — common keys include `system_prompt`, `tools`, `states`, `milestones`, `model`. Treat unknown keys as opaque. type: object additionalProperties: true is_active: type: boolean description: >- Whether this agent can be run. Inactive agents reject runs with `403`. created_at: type: string format: date-time updated_at: type: string format: date-time AgentStatus: type: string description: | Lifecycle status of an agent version. - `draft` — work-in-progress, not yet runnable for end users - `published` — live, runnable - `archived` — superseded by a newer version enum: - draft - published - archived Error: type: object required: - error properties: error: type: string description: Human-readable error message. examples: - Invalid agent_id format responses: BadRequest: description: >- Malformed request — invalid UUID, missing required field, or oversized file. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: API key is valid but the resource belongs to a different workspace. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Agent or task not found. content: application/json: schema: $ref: '#/components/schemas/Error' ServerError: description: Unexpected server error. Safe to retry with exponential backoff. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: | Workspace API key issued from the web app. Pass as `Authorization: Bearer YOUR_API_KEY`. ````