accounts/docs/api-endpoints.md

API Endpoints

This document describes the HTTP endpoints provided by the XControl server. Each entry lists the request method and path, required parameters, and a sample curl command for verification.

GET /api/users

• Description: Return all users.
• Parameters: None.
• Test:

  curl -s http://localhost:8080/api/users
  

GET /api/nodes

• Description: Return all nodes.
• Parameters: None.
• Test:

  curl -s http://localhost:8080/api/nodes
  

POST /api/sync

• Description: Clone or update a knowledge repository.
• Body Parameters (JSON):
  • repo_url – Git repository URL.
  • local_path – Destination directory on the server.
• Test:

  curl -X POST http://localhost:8080/api/sync \
    -H "Content-Type: application/json" \
    -d '{"repo_url": "https://github.com/example/repo.git", "local_path": "/tmp/repo"}'
  

POST /api/rag/sync

• Description: Trigger RAG background synchronization. The endpoint streams plain-text progress logs during the sync.
• Parameters: None.
• Test:

  curl -N -X POST http://localhost:8080/api/rag/sync
  

• Notes: A future evolution could expose this operation via a gRPC streaming RPC. That approach would allow high-speed synchronization, rate limiting, and resumable transfers over long-lived connections while supporting dynamic, lossless queues for weak networks.

POST /api/rag/upsert

• Description: Upsert pre-embedded document chunks into the RAG database.
• Body Parameters (JSON):
  • docs – Array of documents each containing repo, path, chunk_id, content, embedding, metadata, and content_sha.
• Test:

curl -X POST http://localhost:8080/api/rag/upsert
-H "Content-Type: application/json" --data-binary @/Users/shenlan/workspaces/XControl/docs/upsert_1024.json

Expected response on success: `{"rows":1}`. If the vector database is unavailable, the endpoint returns `{"rows":0,"error":"..."}`.

## POST /api/rag/query
- **Description:** Query the RAG service.
- **Body Parameters (JSON):**
- `question` – Query text.
- **Test:**
```bash
curl -X POST http://localhost:8080/api/rag/query \
  -H "Content-Type: application/json" \
  -d '{"question": "What is XControl?"}'

When copying the multi-line example above, ensure your shell treats the trailing \ characters as line continuations. Copying literal \n sequences will cause curl: (3) URL rejected: Bad hostname errors. You can also run the command on a single line without the backslashes:

curl -X POST http://localhost:8080/api/rag/query -H "Content-Type: application/json" -d '{"question": "What is XControl?"}'

POST /api/askai

• Description: Ask the AI service for an answer. Requires a valid Chutes token in the server configuration.
• Body Parameters (JSON):
  • question – Question text.
• Test:

  curl -X POST http://localhost:8080/api/askai \
    -H "Content-Type: application/json" \
    -d '{"question": "Hello"}'