Welcome to the Shinkai API documentation. This API provides a comprehensive set of tools for managing AI-powered workflows, file systems, and cryptocurrency wallets. Whether you’re building advanced AI applications, managing subscriptions, or handling digital assets, the Shinkai API offers the flexibility and power you need.

​
API Overview

Our API is organized into several key sections, each focusing on a specific aspect of the Shinkai ecosystem:

​
General

The General section covers core functionality and system-wide operations. Here you’ll find endpoints for managing LLM providers, handling embedding models, and performing essential system checks.

​
Jobs

The Jobs section is dedicated to managing AI tasks and workflows. It includes endpoints for creating and managing jobs, handling file inboxes, and interacting with Language Model (LLM) providers.

​
Subscriptions

In the Subscriptions section, you’ll find tools for managing shared content and user subscriptions. This includes creating shareable folders, managing notifications, and handling subscriber lists.

​
Tool Offerings

The Tool Offerings section provides endpoints for managing and accessing various tools available within the Shinkai ecosystem. This includes listing, adding, and removing tool offerings.

​
Vector File System (vecfs)

The Vector File System (vecfs) section offers powerful file management capabilities optimized for AI operations. It includes endpoints for file conversion, folder management, and vector-based file searches.

​
Wallet

The Wallet section provides cryptocurrency wallet management features. This includes creating and restoring wallets, as well as processing payments.

Each section of the API is designed to be intuitive and powerful, allowing you to build sophisticated applications on top of the Shinkai platform. As you explore the documentation, you’ll find detailed information about each endpoint, including request parameters, response formats, and example usage.

We’re excited to see what you’ll build with the Shinkai API. Let’s get started!

Was this page helpful?

Add LLM Provider