API Reference

The FixAtlas AI REST API allows you to integrate our knowledge graph into your applications.

Base URL: https://api.fixatlas.tech/v1

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Generate API keys from your dashboard under Settings → API Keys.

Search your knowledge base using natural language queries.

GET /search?q={query}&limit={limit}

Parameters:
- q (required): Search query string
- limit (optional): Max results (default: 10, max: 100)
- equipment_id (optional): Filter by equipment

Response:
{
  "results": [
    {
      "id": "doc_123",
      "title": "Hydraulic Pump Replacement",
      "snippet": "To replace the hydraulic pump...",
      "score": 0.95,
      "source": "manual"
    }
  ],
  "total": 42
}

Documents

Upload and manage documents in your knowledge base.

POST /documents
Content-Type: multipart/form-data

Parameters:
- file (required): Document file
- equipment_id (optional): Associated equipment
- tags (optional): Comma-separated tags

GET /documents/{id}
DELETE /documents/{id}

Equipment

Manage equipment records and their associated knowledge.

GET /equipment
GET /equipment/{id}
POST /equipment
PUT /equipment/{id}
DELETE /equipment/{id}

Tickets

Access work order and ticket data.

GET /tickets
GET /tickets/{id}
GET /tickets/{id}/similar

Error Codes

The API uses standard HTTP status codes:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Server Error