AI Construction API Documentation Aething API Documentation

Comprehensive API documentation for Aething Construction AI Assistant. Access endpoints for user management, project creation, and AI-powered construction tools.

Authentication View Endpoints
API Documentation
GET /api/v1/users
List all users
POST /api/v1/projects
Create new project
GET /api/v1/prompts
Manage AI prompts

Authentication Authentication

API Key Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

API requests are limited to 100 requests per minute per API key. Exceeding this limit will result in a 429 status code.

X-RateLimit-Remaining: 95

API Endpoints

User Management

POST /api/v1/users

Create User

Create a new user in the system.

Request Body:
{
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "role": "user"
}
Response:
{
  "id": 123,
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "role": "user",
  "created_at": "2025-08-02T19:00:00Z"
}
GET /api/v1/users

List Users

Retrieve a list of all users.

Query Parameters:
  • page - Page number (default: 1)
  • limit - Items per page (default: 10)
  • role - Filter by user role
Response:
{
  "users": [...],
  "total": 50,
  "page": 1,
  "limit": 10
}

Project Management

POST /api/v1/projects

Create Project

Create a new construction project.

Request Body:
{
  "name": "Office Building A",
  "description": "New office complex",
  "location": "Downtown",
  "start_date": "2025-09-01",
  "end_date": "2026-06-30"
}
Response:
{
  "id": 456,
  "name": "Office Building A",
  "description": "New office complex",
  "location": "Downtown",
  "start_date": "2025-09-01",
  "end_date": "2026-06-30",
  "status": "active"
}
GET /api/v1/projects

List Projects

Retrieve a list of all projects.

Query Parameters:
  • page - Page number (default: 1)
  • limit - Items per page (default: 10)
  • status - Filter by project status
Response:
{
  "projects": [...],
  "total": 25,
  "page": 1,
  "limit": 10
}

API Keys Management

POST /api/v1/api-keys

Create API Key

Generate a new API key for authentication.

Authorization: Bearer YOUR_API_KEY
Response: 201 Created
GET /api/v1/api-keys

List API Keys

Retrieve all API keys for the authenticated user.

Authorization: Bearer YOUR_API_KEY
Response: 200 OK

User Groups Management

POST /api/v1/user-groups

Create User Group

Create a new user group for team organization.

Authorization: Bearer YOUR_API_KEY
Response: 201 Created
GET /api/v1/user-groups

List User Groups

Retrieve all user groups for the company.

Authorization: Bearer YOUR_API_KEY
Response: 200 OK
GET /api/v1/user-groups/{group_id}

Get User Group

Retrieve details of a specific user group.

Authorization: Bearer YOUR_API_KEY
Response: 200 OK
PUT /api/v1/user-groups/{group_id}

Update User Group

Update an existing user group.

Authorization: Bearer YOUR_API_KEY
Response: 200 OK
DELETE /api/v1/user-groups/{group_id}

Delete User Group

Delete a user group and all its members.

Authorization: Bearer YOUR_API_KEY
Response: 204 No Content
POST /api/v1/user-groups/{group_id}/members

Add Member to Group

Add a user to a specific group.

Authorization: Bearer YOUR_API_KEY
Response: 201 Created

Error Handling

HTTP Status Codes

200 Success
400 Bad Request
401 Unauthorized
403 Forbidden
429 Rate Limit Exceeded
500 Internal Server Error

Error Response Format

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format",
    "details": {
      "field": "email",
      "value": "invalid-email"
    }
  }
}

Security

Best Practices

  • Keep your API keys secure
  • Use HTTPS for all requests
  • Implement proper error handling
  • Monitor rate limits
  • Validate all input data

Rate Limiting

Standard Plan: 100 requests/minute

Premium Plan: 1000 requests/minute

Enterprise Plan: Custom limits

Ready to Get Started?

Start integrating with our API today and transform your construction workflows.

Get API Key Sign Up