Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Publish knowledge draft

POST /api/agents/knowledge

Publish the exact reviewed knowledge draft only after explicit user approval, using the returned draft timestamp. Does not send messages or change agent autonomy.

Parameters

workspaceId

string

No description.

expectedDraftCreatedAtrequired

string

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agents/knowledge" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"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"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.