IFS REST API Model

AI-powered REST API template matching and payload generation

For Administrators

Train the AI model with REST API examples and templates

Go to Training
View Statistics

Monitor model performance and prediction accuracy

View Stats
API Documentation

Access API endpoints for predictions and training

View Docs

API Endpoints

🔐 Authentication Required: All API endpoints require an API key to be sent in the request header.
Use header: X-API-Key: your-api-key-here
Different endpoints require different API keys (predict, train, or stat).

Endpoint URL: POST /api/predict
🔑 Required API Key: API_KEY_PREDICT
Include in header: X-API-Key: your_predict_key_here

Description: Get API template matched to your URL with filled payload

Request Headers:

X-API-Key: your_predict_api_key_here
Content-Type: application/json

Request Body:

{
  "url": "https://your-domain.com/path/to/endpoint",
  "method": "GET",
  "data": {
    "Company": "ABC",
    "Account": "1000"
  }
}

Response:

{
  "success": true,
  "filled_url": "https://your-domain.com/...",
  "filled_payload": {...},
  "method": "POST",
  "confidence": 0.95
}

Note: Response URL uses YOUR domain, not the training template's domain.

Endpoint URL: GET /api/prediction-history
🔑 Required API Key: API_KEY_PREDICT
Include in header: X-API-Key: your_predict_key_here

Description: Retrieve history of all predictions made

Endpoint URL: POST /api/train
🔑 Required API Key: API_KEY_TRAIN
Include in header: X-API-Key: your_train_key_here

Description: Add a new training example to the model

Request Headers:

X-API-Key: your_train_api_key_here
Content-Type: application/json

Request Body:

{
  "service_location": "https://cloud.platnedcloud.com/...",
  "method": "POST",
  "endpoint_url": "https://cloud.platnedcloud.com/.../AccountSet",
  "payload_template": {...},
  "description": "Optional description"
}

Endpoint URL: GET /api/training-data
🔑 Required API Key: API_KEY_TRAIN
Include in header: X-API-Key: your_train_key_here

Description: Retrieve all training examples

Endpoint URL: POST /api/bulk-train
🔑 Required API Key: API_KEY_TRAIN
Include in header: X-API-Key: your_train_key_here

Description: Add multiple training examples at once

Endpoint URL: GET /api/stats
🔑 Required API Key: API_KEY_STAT
Include in header: X-API-Key: your_stat_key_here

Description: Get model statistics and performance metrics

Request Headers:

X-API-Key: your_stat_api_key_here

Response:

{
  "success": true,
  "stats": {
    "total_training_examples": 10,
    "total_predictions": 50,
    "average_confidence": 0.85
  }
}

Endpoint URL: GET /api/model-accuracy
🔑 Required API Key: API_KEY_STAT
Include in header: X-API-Key: your_stat_key_here

Description: Get detailed model accuracy metrics

Endpoint URL: GET /api/health
✅ No API Key Required - This endpoint is public

Description: Check if the API is healthy and running

Test the API

Your API key will be saved locally in your browser