API Reference

API Reference

The Lexsis AI API allows you to programmatically submit feedback, retrieve analytics, and integrate Lexsis AI into your workflows. This documentation covers all available endpoints and how to use them.

Base URL

All API requests should be made to:

https://api.trylexsis.com

Authentication

The Lexsis AI API uses API key authentication. You'll need an API key with the appropriate permissions to access endpoints.

Getting Your API Key

1. Log in to your Lexsis AI account

2. Navigate to Settings → API Keys

3. Create a new API key

4. Select the permissions you need (read, write, or both)

5. Copy and securely store your API key

Using Your API Key

Include your API key in the Authorization header of all requests:

Authorization: Bearer YOUR_API_KEY

API Key Permissions

• Read: Allows you to retrieve data (submissions, segments, buckets, analytics)

• Write: Allows you to create submissions and trigger processing

API Versioning

The API is versioned. The current version is v1. All endpoints are prefixed with /v1/.

Example:

https://api.trylexsis.com/v1/submissions

Rate Limits

API rate limits help ensure fair usage and system stability. Rate limits are applied per API key and are subject to change.

• Standard tier: 100 requests per minute

• Enterprise tier: Custom rate limits based on your plan

Rate limit headers are included in all responses:

• X-RateLimit-Limit: Maximum number of requests allowed

• X-RateLimit-Remaining: Number of requests remaining

• X-RateLimit-Reset: Time when the rate limit resets

Request Format

Headers

All requests should include:

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Request Body

For POST and PUT requests, include a JSON body:

{
  "field1": "value1",
  "field2": "value2"
}

Response Format

Success Responses

Successful requests return a JSON response with a status field:

{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {
    // Response data
  }
}

Error Responses

Errors return appropriate HTTP status codes and error details:

{
  "status": "error",
  "message": "Error description",
  "detail": "Detailed error information"
}

HTTP Status Codes

• 200 OK: Request successful

• 201 Created: Resource created successfully

• 400 Bad Request: Invalid request parameters

• 401 Unauthorized: Invalid or missing API key

• 403 Forbidden: Insufficient permissions

• 404 Not Found: Resource not found

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error: Server error

Available Endpoints

Feedback Submission

• Submit Feedback - Submit feedback directly via REST API

• CSV Upload - Upload feedback in bulk via CSV/Excel

Next Steps

• Submit Feedback via REST API - Learn how to submit feedback programmatically

• CSV Upload Guide - Learn how to upload feedback in bulk

• Getting Started Guide - Set up your account and first integration

Need Help?

• Check the specific endpoint documentation for detailed examples

• Review error messages for troubleshooting

• Contact support for API key issues or rate limit questions