MyOpsAgent Customer Setup & Onboarding Guide

1. Understanding the MyOpsAgent Platform

MyOpsAgent is an API-driven decision engine that evaluates:

• Work items (tasks, jobs, tickets, requests)
• Resources (people, machines, vehicles, rooms)
• Constraints (rules, requirements, limitations)
• Context (time, environment, organisational policies)

It returns:

• The best resource for the job
• A confidence score
• A breakdown of reasoning factors
• A unique decision ID
• A correlation ID for audit tracing

Every decision is deterministic, explainable, and logged for compliance, giving you a reliable operational record of how and why decisions were made.

2. Creating Your Organisation

Your organisation is created by the MyOpsAgent team during onboarding. This ensures:

• Correct configuration
• Secure API key provisioning
• Proper multi-tenant isolation

Once created, you will receive:

• org_id — your organisation’s unique identifier
• initial_api_key — your first operational API key
• admin_key (optional) — used for managing API keys

These credentials allow you to authenticate with the platform and begin making decision requests.

3. Generating Additional API Keys

Most organisations use multiple API keys for:

• Production
• Staging
• Development
• CI/CD pipelines
• Partner integrations

To generate a new key, call:

POST /?route=create_api_key

Headers

X-Admin-Key: <admin_key>
Content-Type: application/json

Request Example

{
  "org_id": 1,
  "label": "Production Key"
}

Response Example

{
  "status": "ok",
  "api_key": "xxxx",
  "org_id": 1,
  "label": "Production Key",
  "correlation_id": "...",
  "duration_ms": 1.3
}

Important: Store your API keys securely. Treat them like passwords.

4. Revoking API Keys

If a key is compromised or no longer needed, revoke it immediately.

POST /?route=revoke_api_key

Request Example

{
  "api_key": "xxxx"
}

Revocation is immediate and irreversible.

5. Preparing Your System for Integration

Before sending your first decision request, ensure your system can provide the following data structures.

A. Work Item Data

Each work item should include:

• A unique ID
• Required capabilities
• Optional location
• Optional metadata

B. Resource Data

Each resource should include:

• A unique ID
• Capabilities
• Optional location
• Optional availability
• Optional metadata

C. Constraints

Constraints may include:

• Required skills
• Forbidden assignments
• Time windows
• Organisational rules

D. Context

Contextual information such as:

• Current time
• Environmental conditions
• Organisational policies

6. Making Your First Decision Request

Send a POST request to:

POST /?route=decide

Headers

X-API-Key: <your_api_key>
Content-Type: application/json

Example Request

{
  "work_item": {
    "id": "WI-123",
    "required_capabilities": ["temperature", "pressure"],
    "location": null,
    "metadata": {}
  },
  "resources": [
    {
      "id": "engineer-001",
      "capabilities": ["temperature", "pressure"],
      "location": null,
      "availability": null,
      "metadata": {}
    }
  ],
  "constraints": [],
  "context": {
    "current_time": "2026-01-16T17:47:02Z",
    "org_rules": {},
    "environment": {}
  }
}

Example Response

{
  "decision_id": "ccf1e43c...",
  "org_id": 1,
  "work_item_id": "WI-123",
  "chosen_resource_id": "engineer-001",
  "alternatives": {},
  "confidence": 0.5,
  "reasoning_factors": [
    {"factor": "capability_match", "weight": 0.5, "value": 1},
    {"factor": "distance", "weight": 0.3, "value": 0.5},
    {"factor": "availability", "weight": 0.2, "value": 0.5}
  ],
  "engine_version": "v1.0.0",
  "correlation_id": "d6b6ada7...",
  "duration_ms": 4.98
}

7. Validating Your Integration

After your first successful decision, validate the following:

A. Decision Output

• Is the chosen resource correct?
• Do the reasoning factors make sense?
• Is the confidence score reasonable?

B. Audit Logging

Check that the decision appears in your audit logs.

C. Usage Tracking

Verify that your usage counters incremented:

• total_requests
• decisions_count

D. Error Handling

Test scenarios such as:

• Invalid API key
• Malformed JSON
• Rate limit exceeded

Your system should gracefully handle all error codes.

8. Best Practices for Production Use

1. Use Separate API Keys for Each Environment

• Development
• Staging
• Production

2. Rotate Keys Regularly

Rotating keys every 90 days is recommended.

3. Log Correlation IDs

This allows you to trace decisions end-to-end across your systems.

4. Validate Inputs Before Sending

Avoid unnecessary errors by validating payloads on your side first.

5. Monitor Usage

Stay within your rate limits and usage caps to avoid throttling.

6. Use HTTPS Only

Never send API keys over insecure connections.

9. Support & Troubleshooting

If you encounter issues:

• Check the correlation ID
• Review your logs
• Verify your API key
• Confirm your JSON structure
• Test the /health endpoint

If you need assistance, contact your MyOpsAgent support representative with the correlation ID and relevant log excerpts.

Conclusion

This guide provides everything you need to begin using MyOpsAgent effectively. By following these steps, you can integrate the decision engine into your systems quickly and confidently, enabling automated, consistent, and auditable operational decisions.

MyOpsAgent is designed to grow with your organisation — from your first decision to enterprise-scale automation.