API Documentation

Note:

The current API is for developers to play around with and make personal projects for certain use cases, and not for larger scale or distributed use cases. We will later introduce a developer vetting system as sharing API keys can allow excess permissions for developers, and will update the API accordingly then. In the communities, you are allowed to promote the actual project that you've built, but are not allowed to solicit users for it due to the excess key permissions currently. Please contact [email protected] for serious inquiries.



Base URL

https://api.kindroid.ai/v1

Authentication

All endpoints require authentication, use the Authorization header with Bearer {Your API key, which should start with kn_...}. Your API key and AI ID can be found in General settings.

WARNING: You should only play around with the API if you're a developer interested in tinkering with integrating Kindroid. DO NOT share your key with anyone who asks, and unless it comes from admins do not trust other sources. Someone with your API key could do anything do your account, including deleting it.

Endpoints

These few are the select ones we openly document for integrations currently. We may expand featuresets for API at a later point in time.

Send Message

Sends a message to an AI and receives a response. This request may take a long time, so you should await for its response.

  • URL: /send-message
  • Method: POST
  • Request Body:
    • { "ai_id": "string", "message": "string" }
  • Response:
    • Success: 200 OK with AI response
    • Error: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error

Chat break

Ends a chat and resets the short term memory. Greeting is mandatory & is the first message in a new conversation.

  • URL: /chat-break
  • Method: POST
  • Request Body:
    • { "ai_id": "string", "greeting": "string" }
  • Response:
    • Success: 200 OK
    • Error: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error