Getting Started

Xharvoc's APIs enable you to integrate our services into your applications. All APIs are RESTful and return JSON responses.

Base URL: https://api.xharvoc.co.uk/v1

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header:

bash

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.xharvoc.co.uk/v1/resource

Important

Keep your API keys secure. Never expose them in client-side code or public repositories.

API Endpoints

Our API is organised into logical resource groups:

/conversations - Manage conversational AI sessions
/workflows - Create and execute automated workflows
/analytics - Access business intelligence data
/users - User management and authentication
/integrations - Configure external integrations

Error Handling

API errors return standard HTTP status codes with detailed error messages:

json

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is missing required field: name",
    "details": {
      "field": "name",
      "reason": "required"
    }
  }
}

Rate Limits

API requests are rate-limited to ensure fair usage:

Standard tier: 100 requests per minute
Professional tier: 500 requests per minute
Enterprise tier: Custom limits

Pro Tip

Implement exponential backoff when handling rate limit errors (HTTP 429).

API Documentation

In this article

Getting Started

Authentication

API Endpoints

Error Handling

Rate Limits

Was this article helpful?

Related Articles

SDK Installation Guide

Webhooks & Events

Custom Development