---
title: "Create or Update Creator Agent"
method: POST
path: "/document_generation/creator-agent-put"
tags: ["Document AI — DMS"]
---

# Create or Update Creator Agent

`POST /document_generation/creator-agent-put`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/document_generation/creator-agent-put`
- Auth: HTTP bearer

Create a Creator Agent (omit agent_id, HTTP 201) or update one (HTTP 200; agent_config keys are merged into the stored configuration).

## Request body

- object
  - `agent_id` string: Omit to create; set to update an existing Creator Agent.
  - `name` string: Display name (required when creating).
  - `active` boolean: Activate or deactivate the agent.
  - `notes` string: Internal notes.
  - `agent_config` object: Configuration (see description). Required when creating; partial objects are merged when updating.
    - `template_id` string
    - `template_version` integer: Omit or null for the current version.
    - `workspace_id` integer
    - `knowledge_ids` integer[]
    - `pinned_article_ids` string[]
    - `instruction` string
    - `writing_rules` object
    - `default_variables` object
    - `llm_tier` 'basic' | 'premium' | 'ultra': Agent tier (default basic).
    - `numbers_policy` 'grounded_only' | 'allow_llm'
    - `use_crm` boolean
    - `use_company_profile` boolean
    - `use_documents` boolean
    - `review_mode` 'preview_required' | 'auto'
    - `locale` string
    - `title_pattern` string
    - `ai_dms_tier` string
    - `numbering` object: Automatic numbering: path (text field, e.g. offer.number) and pattern with {SEQ} or {SEQ:n} and optional {YYYY} {YY} {MM} {DD}. null disables.
      - `path` string
      - `pattern` string

## Response `200`

Success

- SuccessEnvelope: Success envelope. Payload fields are endpoint-specific (top-level fields, `result`/`job_result` for jobs, `data` on some account endpoints).
  - `status` 'success', required
  - `processing_time` union
    - string
    - number
  - `_billing` object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)