Tool reference

    Schedule a template article

    Make an authorized change through your connected assistant.

    MCP TOOL outwrite_create_template_article

    outwrite_create_template_article

    Save a one-off article using a template and its reusable fields in this brand. Normal article credits apply when prepared. Destination is always a reviewable draft, never automatic publication. Return the saved id; use the available article preparation tool (prepare_article for MCP, prepare_saved_article for Ask outwrite.ai) to start writing now if requested. Requires explicit user intent, confirm:true, a UUID idempotencyKey and maximumCredits for this immediate action. Recurring settings require recurringConsent:true after the user approves their ongoing costs. Retry identical arguments with the same key; inspect an uncertain receipt before any new action.

    Access and behavior

    PropertyValue
    Permissionpro:write
    EffectCan change your workspace

    Read the current workspace state before making a change. Respect the returned proposal, revision and operation state rather than assuming the request has finished.

    Parameters

    ParameterRequiredTypeDetails
    workspaceIdOptionalstringFormat: uuid.
    idRequiredstringFormat: uuid.
    templateIdRequiredstringFormat: uuid.
    templateValuesOptionalobjectDefault: {}.
    topicRequiredstringAt least 3 characters. Up to 500 characters.
    scheduledAtRequiredstringFormat: date-time.
    lengthOptionalstringOne of: short, medium, long, comprehensive. Default: "medium".
    idempotencyKeyRequiredstringFormat: uuid.
    confirmRequiredbooleanValue: true.
    maximumCreditsRequirednumberMinimum 0. Maximum 100000.
    recurringConsentOptionalbooleanDefault: false.

    Complete input schema

    The schema is generated from the registered tool contract. Account permissions, revision checks and cross-field validation also apply on the server.

    Code example
    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "templateId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "templateValues": {
          "default": {},
          "type": "object",
          "propertyNames": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,29}$"
          },
          "additionalProperties": {
            "type": "string",
            "maxLength": 300
          }
        },
        "topic": {
          "type": "string",
          "minLength": 3,
          "maxLength": 500
        },
        "scheduledAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "length": {
          "default": "medium",
          "type": "string",
          "enum": [
            "short",
            "medium",
            "long",
            "comprehensive"
          ]
        },
        "idempotencyKey": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "confirm": {
          "type": "boolean",
          "const": true
        },
        "maximumCredits": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000
        },
        "recurringConsent": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "templateId",
        "topic",
        "scheduledAt",
        "idempotencyKey",
        "confirm",
        "maximumCredits"
      ],
      "additionalProperties": false
    }
    

    Working safely

    For an identical retry, reuse its idempotency key. If the saved state changed, read it again and prepare a new request. An operation that is queued or running is not complete.

    See permissions and safe actions and assistant workflows.

    Need a hand with your workspace?Get help