Knowledge Portal Manager APIs (4.0.0)

Download OpenAPI specification:Download

License

The following licenses are required to use the Knowledge Access APIs:

  • If the user is an agent, then the Knowledge + AI license is required.
  • If the user is a customer, the Self-Service and Advanced Self-Service licenses must be available.

Tiers

Tier Tier Name Named Users Description
Tier 1 Starter Up to 10 Designed for small-scale implementations or pilot environments
Tier 2 Growth Up to 1000 Suitable for mid-scale deployments requiring moderate scalability
Tier 3 Enterprise Greater than 1000 Supports large-scale environments with extended configuration options

API Resource Limits

The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.

Resource Limits Starter Growth Enterprise
Article Reference Number of attachments used in any article 25 50 50
Number of custom attributes in an article 10 25 50
Number of publish views used in an article version 20 20 20
Topic Reference User-defined topics in a department 1000 5000 50000
Depth of topics 5 20 20
Topics at any level 500 2500 2500
Number of custom attributes in a topic 10 10 10
Portal Reference Tag categories in a portal 15 15 15
Topics to be included in a portal 100 500 5000
Number of articles to display in announcements 10 25 25
Usage links and link groups setup for a portal 5 10 25

Service Level Agreement (SLA)

This API has different rate limits and quotas based on your subscription plan.

Available Plans

Developer Plan

  • Cost: $1/month
  • Rate Limits:
    • default:
      • POST: 1 requests per second
      • Burst: 20 concurrent requests
  • Quotas:
    • default:
      • POST: 10000 requests per month

Basic Plan

  • Cost: $1/month
  • Rate Limits:
    • default:
      • POST: 10 requests per second
      • Burst: 200 concurrent requests
  • Quotas:
    • default:
      • POST: 100000 requests per month

Enterprise Plan

  • Cost: $1/month
  • Rate Limits:
    • default:
      • POST: 60 requests per second
      • Burst: 1200 concurrent requests
  • Quotas:
    • default:
      • POST: 500000 requests per month

Internal Plan

  • Cost: $1/month
  • Rate Limits:
    • default:
      • POST: 60 requests per second
      • Burst: 1200 concurrent requests
  • Quotas:
    • default:
      • POST: 500000 requests per month