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

apiDeterministic

Get knowledge base

Name: Pipeline
Price: 99 USD

GET /api/agents/knowledge

Read shared Reply/SDR knowledge, active version, pending draft and GTM context. Use your coding-agent model to propose improvements without hosted inference.

Parameters

workspaceId

string

No description.

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/agents/knowledge" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

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"
      ]
    },
    "gtm": {
      "type": "object"
    },
    "guidance": {
      "type": "string"
    }
  },
  "required": [
    "knowledge",
    "gtm",
    "guidance"
  ]
}

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.