This article provides a basic introduction to APIs, focused on REST APIs. It assumes no prior knowledge. For an introduction to the KnowledgeOwl API, refer to Using the KnowledgeOwl API , and for KnowledgeOwl API reference documentation, refer to ...
Let's look at how to make an API request with Postman . You'll need to download and install Postman, and sign up for an account. The free tier has everything needed for this tutorial. You also need an API key . An API key is a way of authenticat...
Accessing an API, using GET, POST, and so on, is known as calling the API. To call an API, you make a request . You need to know the endpoint you want to use. An endpoint usually provides functionality around a particular object , allowing you...
There are lots of resources out there to learn more about APIs. Here are a few of our favorites. KnowledgeOwl API Read more about our own API in Using the KnowledgeOwl API and our Endpoint reference . General articles and tutorials about APIs ...
REST stands for "representational state transfer". A REST API is a type of API designed for use on the web. It can perform actions such as getting or updating information in a database. It uses HTTP verbs, or methods, to indicate the type of actio...
API stands for "application programming interface". In basic terms, APIs allow computer programs to talk to each other. The process is broadly the same regardless of the type of API: A client application initiates an API call to retrieve info...
Redoc offers several ways to create API docs. For our own documentation , we use a custom HTML element and Redoc's 'redoc.standalone.js' script. This works by loading the spec file and any configuration options set in the custom element, then assem...
If you have content security policy headers enabled in your knowledge base security settings, you cannot host the files in the KnowledgeOwl file library. The security settings prevent loading the JSON or YAML spec file. You can still load the fil...
Create a new article , or a custom content category . In Display Settings , select Remove feedback ability , Remove comment ability , and Remove "Download to PDF" icon . Host your spec file, choose your Redoc source, and make a note of th...