sdkDeterministic

Save knowledge draft

pipeline.saveKnowledgeDraft

Save the full merged knowledge object as an inactive draft. Read first, preserve existing entries, show proposed changes, and use current draft createdAt (null only when no draft exists).

Parameters

workspaceId

string

No description.

knowledgerequired

object

No description.

changeSummaryrequired

string

No description.

expectedDraftCreatedAtrequired

string | null

No description.

Example

TypeScripttypescript

await pipeline.saveKnowledgeDraft({
  "knowledge": {
    "offer": "example",
    "approvedFacts": [
      "example"
    ],
    "faqs": [
      {
        "question": "example",
        "answer": "example"
      }
    ],
    "objections": [
      {
        "objection": "example",
        "response": "example"
      }
    ],
    "proof": [
      "example"
    ],
    "assets": [
      {
        "name": "example",
        "description": "example",
        "url": "https://example.com"
      }
    ],
    "tone": [
      "example"
    ],
    "booking": [
      "example"
    ],
    "escalation": [
      "example"
    ]
  },
  "changeSummary": "example",
  "expectedDraftCreatedAt": "2026-01-01T00:00:00.000Z"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "knowledge": {
      "type": "object",
      "properties": {
        "skillId": {
          "type": "string"
        },
        "overlayId": {
          "type": [
            "string",
            "null"
          ]
        },
        "draft": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "versionNumber": {
              "type": "number"
            },
            "status": {
              "type": "string",
              "enum": [
                "draft",
                "active",
                "archived"
              ]
            },
            "changeSummary": {
              "type": "string"
            },
            "createdAt": {
              "type": "string"
            },
            "activatedAt": {
              "type": [
                "string",
                "null"
              ]
            },
            "knowledge": {
              "type": "object"
            }
          },
          "required": [
            "versionNumber",
            "status",
            "changeSummary",
            "createdAt",
            "activatedAt",
            "knowledge"
          ]
        },
        "published": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "versionNumber": {
              "type": "number"
            },
            "status": {
              "type": "string",
              "enum": [
                "draft",
                "active",
                "archived"
              ]
            },
            "changeSummary": {
              "type": "string"
            },
            "createdAt": {
              "type": "string"
            },
            "activatedAt": {
              "type": [
                "string",
                "null"
              ]
            },
            "knowledge": {
              "type": "object"
            }
          },
          "required": [
            "versionNumber",
            "status",
            "changeSummary",
            "createdAt",
            "activatedAt",
            "knowledge"
          ]
        },
        "versions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "versionNumber": {
                "type": "number"
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "active",
                  "archived"
                ]
              },
              "changeSummary": {
                "type": "string"
              },
              "createdAt": {
                "type": "string"
              },
              "activatedAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "knowledge": {
                "type": "object"
              }
            },
            "required": [
              "versionNumber",
              "status",
              "changeSummary",
              "createdAt",
              "activatedAt",
              "knowledge"
            ]
          }
        }
      },
      "required": [
        "skillId",
        "overlayId",
        "draft",
        "published",
        "versions"
      ]
    }
  },
  "required": [
    "knowledge"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.