KB User's Guide - API - What is an API?

This document explains Application Programming Interfaces (APIs) and provides references for using KnowledgeBase (KB) APIs to integrate KB data into external applications.

Two circles, one labeled "Your KB" and the other labeled "Their App".

An Application Programming Interface (API) is a set of rules and protocols that allows different software applications to communicate with one another. APIs define how software components interact and provide a standardized way to send, receive, and exchange data. Because API data is typically separated from its presentation layer, it can be easily consumed and processed by other applications.

A brief overview of how APIs work, as well as an example of how the KB's API can be used in an external application, please see the "Using the KB API to Embed Your Content Anywhere" recording from the 2025 KB User Group Meeting.

FreeCodeCamp also has a helpful in-depth explanation of how APIs work if you are interested in learning more.

See Also


Keywords:
api Application program interface rules protocols software applications software components send receive exchange data standardized send consume consumed process 
Doc ID:
29280
Owned by:
Leah S. in KB User's Guide
Created:
2013-03-29
Updated:
2026-09-10
Sites:
KB User's Guide
Information related to use of the KB's APIs