New Articles

  1. Adding custom styles to your REST API documentation

    There are two ways to customize the look and feel of Redoc's output: Redoc's theming options . You can set these on the element. Note that the available options for the open source community edition are limited. As of 24 September 2021, there...
  2. Working with APIs: Introduction

    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 ...
  3. Calling an API: Postman

    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...
  4. Calling an API: curl

    Learn the basics of calling an API by using curl.
  5. Calling an API: terminology and tools

    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...
  6. Working with APIs: Learn more

    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 ...
  7. What is a REST API?

    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...
  8. What is an API?

    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...
  9. Understand Redoc's standalone API docs

    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...
  10. REST API documentation with content security headers

    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...