CognisentAI API Documentation

Introduction

Welcome to the CognisentAI API documentation. Our API allows you to integrate our powerful AI solutions into your own applications and workflows. This guide will help you get started with using our API effectively.

Authentication

All API requests must be authenticated using an API key. Include your API key in the header of each request:

Authorization: Bearer YOUR_API_KEY

To obtain an API key, please contact our support team or visit your account dashboard.

Base URL

All API requests should be made to the following base URL:

https://api.cognisentai.com/v1

Available Endpoints

Example Usage

curl -X GET "https://api.cognisentai.com/v1/properties" \
-H "Authorization: Bearer YOUR_API_KEY"

curl -X POST "https://api.cognisentai.com/v1/valuations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "address": "123 Main St, Anytown, USA",
  "propertyType": "residential",
  "squareFeet": 2000,
  "bedrooms": 3,
  "bathrooms": 2
}'

Response Format

All responses are returned in JSON format. A typical response will look like this:

{
  "status": "success",
  "data": {
    // Response data here
  },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 100
  }
}

Error Handling

In case of an error, the API will return a JSON response with an error message and appropriate HTTP status code:

{
  "status": "error",
  "message": "Invalid API key",
  "code": "UNAUTHORIZED"
}