Introduction

Base URL

All API requests should be made to:

https://api.stardex.ai

For example, to access the /v1/persons endpoint, you would make a request to:

https://api.stardex.ai/v1/persons

All API endpoints require authentication using Bearer tokens in the Authorization header. Add your API key as follows:

Authorization: Bearer your_api_key_here

You can get your API key from the Stardex Settings.

All API endpoints follow a consistent response format:

{
  "success": true,
  "data": object  // Response data
}

For paginated responses:

{
  "success": true,
  "data": array,
  "meta": {
    "total": number,
    "offset": number,
    "limit": number
  }
}

{
  "success": true,
  "data": {
    "id": "123",
    "name": "John Doe"
    // ... other fields
  }
}

{
  "success": false,
  "error": {
    "code": string,
    "message": string,
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired"
  }
}

Common HTTP Status Codes: