Kindflow

Appearance

API Overview ​

Kindflow provides a comprehensive REST API for programmatic access to conversations, messages, and organization data.

Base URL ​

https://api.kindflow.ai

Authentication ​

All API requests require authentication using an API key passed in the x-api-key header.

Generating an API Key ​

  1. Sign in to your Kindflow dashboard
  2. Navigate to Settings → Team
  3. Scroll to the API Keys section
  4. Click Create API Key
  5. (Optional) Add a description for reference
  6. Copy and save the generated key securely

Important: The API key is only shown once during creation. Store it securely as you won't be able to view it again.

Using Your API Key ​

Include your API key in the request header:

bash
x-api-key: your_api_key_here

Response Format ​

All API responses follow a consistent JSON format:

Success Response:

json
{
  "id": "uuid",
  "field": "value",
  ...
}

Error Response:

json
{
    "error": "Error message",
    "statusCode": 400
}

HTTP Status Codes ​

  • 200 - OK: Request succeeded
  • 201 - Created: Resource successfully created
  • 400 - Bad Request: Invalid request parameters
  • 401 - Unauthorized: Invalid or missing API key
  • 403 - Forbidden: Insufficient permissions
  • 404 - Not Found: Resource does not exist
  • 500 - Internal Server Error: Server error occurred

Rate Limits ​

API requests are subject to rate limits based on your subscription plan. Contact support for specific limits.

Available APIs ​

Best Practices ​

  • Store API Keys Securely: Never expose API keys in client-side code or public repositories
  • Use HTTPS: Always use HTTPS in production
  • Handle Errors: Implement proper error handling for all API responses
  • Implement Retries: Use exponential backoff for transient errors
  • Monitor Usage: Track your API usage to avoid hitting rate limits