Skip to main content

​
Base URL

All API requests should be made to: 
https://api.stardex.ai
For example, to access the /v0/persons endpoint, you would make a request to: 
https://api.stardex.ai/v0/persons

​
Authentication

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.

​
Response Format

All API endpoints follow a consistent response format: 
{
  "error": string | null,  // Error message if something went wrong, null on success
  "data": object | null    // Response data if successful, null on error
}

​
Example Successful Response

{
  "error": null,
  "data": {
    "id": "123",
    "name": "John Doe"
    // ... other fields
  }
}

​
Example Error Response

{
  "error": "Invalid API key",
  "data": null
}
Common HTTP Status Codes:
  • 200: Operation completed successfully
  • 400: Invalid request or missing fields
  • 401: Missing or invalid API key
  • 403: Forbidden - insufficient permissions
  • 404: Resource not found
  • 500: Unexpected server error