Chicory AI
  • Getting Started
    • Introduction to Chicory
    • Quickstart Guide
    • Understanding Chicory
  • API Reference
    • OpenAPI Specification
      • Projects
      • Training
      • Data_sources
      • Messages
      • Chats
      • Health
      • Models
Powered by GitBook
On this page
  • Overview
  • Key Sections
  • Access
  1. API Reference

OpenAPI Specification

API for a multi-tenant platform that enables users to connect data sources, build business ontologies, and interact with data through a chat interface.

Overview

The Chicory AI API is described using the OpenAPI Specification (OAS), a vendor-neutral, language-agnostic format for HTTP APIs.

Key Sections

  • Paths: Define endpoints for data retrieval, transformation, and exploration

  • Components: Schema definitions for requests and responses

  • Security: API key authentication and role-based access controls

Access

Our managed service uses this OpenAPI spec under the hood. To obtain the full YAML/JSON file or to run your own API Gateway, join our waitlist.

Why OpenAPI?

  • Ensures consistency across client libraries and documentation

  • Enables automated code generation and testing workflows

  • Simplifies API versioning and governance

PreviousUnderstanding ChicoryNextProjects

Last updated 1 month ago