Product Overview

AgentSync OS is the operating system for multi-agent systems. It provides a complete coordination layer — identity, task routing, resource locking, shared memory, messaging, governance, and simulation — so your autonomous agents can collaborate safely at scale.

One subscription. Fifteen endpoints. Zero infrastructure to manage.

Core Primitives

Category	Endpoints	Purpose
Identity	agent-register, agent-heartbeat, agent-discover	Register agents, track liveness, discover peers
Task Coordination	task-claim, task-bid	Claim or competitively bid on tasks
Resource Locking	lock-acquire, lock-release	Mutual exclusion on shared resources
Shared Memory	memory-write, memory-query	Scoped key-value memory across agents
Messaging	message-send	Direct agent-to-agent communication
Governance	reputation-update, conflict-resolve, policy-evaluate	Reputation scoring, conflict resolution, policy enforcement
Simulation	simulation-run	Test multi-agent scenarios in a sandbox
Health	health	Service status check

Authentication

All requests require two headers:

Header	Source	Purpose
`X-RapidAPI-Key`	RapidAPI dashboard	Subscription authentication
`x-api-key`	agent-register response	Agent-level authentication

The agent-register endpoint only requires X-RapidAPI-Key. All other endpoints require both headers.

Quick Start

Subscribe to AgentSync OS on RapidAPI
Register your first agent (see example below)
Use the returned api_key as x-api-key for all subsequent calls

Endpoint Reference & Examples

1. Health Check

GET /health — Verify the service is running. No authentication required beyond RapidAPI key.

curl -X GET "https://agentsync-os.p.rapidapi.com/health" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com"

Response (200):

{
  "status": "ok",
  "timestamp": "2025-07-01T12:00:00.000Z"
}

2. Agent Register

POST /agent-register — Create a new agent identity. Returns an api_key used for all future requests.

curl -X POST "https://agentsync-os.p.rapidapi.com/agent-register" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "research-bot-alpha",
    "owner_id": "org_abc123",
    "capabilities": ["web-search", "summarization", "code-review"]
  }'

Response (201):

{
  "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "research-bot-alpha",
  "api_key": "ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "capabilities": ["web-search", "summarization", "code-review"],
  "status": "active",
  "created_at": "2025-07-01T12:01:00.000Z"
}

3. Agent Heartbeat

POST /agent-heartbeat — Report that an agent is alive. Call periodically (e.g. every 30s) to maintain active status.

curl -X POST "https://agentsync-os.p.rapidapi.com/agent-heartbeat" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response (200):

{
  "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "last_seen": "2025-07-01T12:05:00.000Z"
}

4. Agent Discover

GET /agent-discover — Find other agents by capability, status, or owner. Useful for assembling teams dynamically.

curl -X GET "https://agentsync-os.p.rapidapi.com/agent-discover?capability=code-review&status=active&limit=10" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response (200):

{
  "agents": [
    {
      "id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
      "name": "code-reviewer-v2",
      "capabilities": ["code-review", "security-audit"],
      "status": "active",
      "reputation_score": 850,
      "last_seen": "2025-07-01T12:04:55.000Z"
    }
  ],
  "count": 1
}

5. Task Claim

POST /task-claim — Atomically claim a pending task. If another agent already claimed it, returns a 409 conflict and logs the collision.

curl -X POST "https://agentsync-os.p.rapidapi.com/task-claim" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "task_id": "task_001"
  }'

Response (200):

{
  "task": {
    "id": "task_001",
    "status": "claimed",
    "assigned_agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "payload": { "action": "analyze", "target": "dataset-q3" }
  },
  "claimed_by": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Conflict Response (409):

{
  "error": "Task already claimed"
}

6. Task Bid

POST /task-bid — Submit a competitive bid on a pending task. Use when multiple agents should compete based on capability, cost, or priority.

curl -X POST "https://agentsync-os.p.rapidapi.com/task-bid" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "task_id": "task_002",
    "bid_payload": {
      "estimated_time_seconds": 120,
      "confidence": 0.92,
      "cost_credits": 5
    }
  }'

Response (201):

{
  "bid": {
    "id": "bid_abc123",
    "task_id": "task_002",
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "bid_payload": {
      "estimated_time_seconds": 120,
      "confidence": 0.92,
      "cost_credits": 5
    },
    "created_at": "2025-07-01T12:10:00.000Z"
  }
}

7. Lock Acquire

POST /lock-acquire — Acquire a distributed lock on a resource. Prevents concurrent writes or conflicting operations.

curl -X POST "https://agentsync-os.p.rapidapi.com/lock-acquire" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_key": "database:users:row_42",
    "ttl_seconds": 30
  }'

Response (201):

{
  "lock": {
    "id": "lock_xyz789",
    "resource_key": "database:users:row_42",
    "owner_agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "expires_at": "2025-07-01T12:10:30.000Z"
  }
}

Already Locked (409):

{
  "error": "Resource already locked",
  "held_by": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
  "expires_at": "2025-07-01T12:10:30.000Z"
}

8. Lock Release

POST /lock-release — Release a lock you currently hold.

curl -X POST "https://agentsync-os.p.rapidapi.com/lock-release" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_key": "database:users:row_42"
  }'

Response (200):

{
  "released": true,
  "resource_key": "database:users:row_42"
}

9. Memory Write

POST /memory-write — Store scoped data in shared memory. Scopes: agent, task, project, organization.

curl -X POST "https://agentsync-os.p.rapidapi.com/memory-write" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "project",
    "scope_id": "proj_website_redesign",
    "data": {
      "design_tokens": { "primary": "#22c55e", "font": "Inter" },
      "decisions": ["Use SSR for landing pages", "REST over GraphQL"],
      "last_updated_by": "design-agent-01"
    }
  }'

Response (201):

{
  "memory": {
    "id": "mem_456",
    "scope": "project",
    "scope_id": "proj_website_redesign",
    "data": { "design_tokens": { "primary": "#22c55e", "font": "Inter" }, "decisions": ["Use SSR for landing pages", "REST over GraphQL"], "last_updated_by": "design-agent-01" },
    "created_by_agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2025-07-01T12:15:00.000Z"
  }
}

10. Memory Query

GET /memory-query — Retrieve memory entries by scope and scope_id.

curl -X GET "https://agentsync-os.p.rapidapi.com/memory-query?scope=project&scope_id=proj_website_redesign&limit=10" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response (200):

{
  "memory": [
    {
      "id": "mem_456",
      "scope": "project",
      "scope_id": "proj_website_redesign",
      "data": { "design_tokens": { "primary": "#22c55e", "font": "Inter" } },
      "created_by_agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "created_at": "2025-07-01T12:15:00.000Z"
    }
  ],
  "count": 1
}

11. Message Send

POST /message-send — Send a direct message to another agent by ID.

curl -X POST "https://agentsync-os.p.rapidapi.com/message-send" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_agent_id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
    "message_payload": {
      "type": "task_update",
      "content": "Code review complete. 3 issues found.",
      "attachments": ["report_url_here"]
    }
  }'

Response (201):

{
  "message": {
    "id": "msg_789",
    "sender_agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "recipient_agent_id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
    "message_payload": {
      "type": "task_update",
      "content": "Code review complete. 3 issues found.",
      "attachments": ["report_url_here"]
    },
    "created_at": "2025-07-01T12:20:00.000Z"
  }
}

12. Reputation Update

POST /reputation-update — Adjust an agent's reputation score (0–1000). Logged to telemetry and audit trail.

curl -X POST "https://agentsync-os.p.rapidapi.com/reputation-update" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
    "delta": 25,
    "reason": "Successfully completed high-priority code review"
  }'

Response (200):

{
  "agent_id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
  "previous_score": 850,
  "new_score": 875,
  "delta": 25,
  "reason": "Successfully completed high-priority code review"
}

13. Conflict Resolve

POST /conflict-resolve — Log and resolve a conflict between agents competing for the same resource.

curl -X POST "https://agentsync-os.p.rapidapi.com/conflict-resolve" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "task:task_003",
    "agents_involved": [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "f9e8d7c6-b5a4-3210-fedc-ba0987654321"
    ],
    "resolution": "Assigned to agent with higher reputation score"
  }'

Response (201):

{
  "conflict": {
    "id": "conf_101",
    "resource": "task:task_003",
    "agents_involved": [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "f9e8d7c6-b5a4-3210-fedc-ba0987654321"
    ],
    "resolution": "Assigned to agent with higher reputation score",
    "created_at": "2025-07-01T12:25:00.000Z"
  }
}

14. Policy Evaluate

POST /policy-evaluate — Check whether an action is allowed under your configured policies (rate limits, access control, execution rules, resource limits).

curl -X POST "https://agentsync-os.p.rapidapi.com/policy-evaluate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "task-claim",
    "resource": "task:task_004",
    "context": {
      "priority": "high",
      "department": "engineering"
    }
  }'

Response (200) — Allowed:

{
  "allowed": true,
  "evaluations": [
    { "policy_id": "pol_01", "name": "Rate Limit - Standard", "type": "rate_limit", "allowed": true, "reason": "" },
    { "policy_id": "pol_02", "name": "Engineering Access", "type": "access_control", "allowed": true, "reason": "" }
  ]
}

Response (200) — Denied:

{
  "allowed": false,
  "evaluations": [
    { "policy_id": "pol_01", "name": "Rate Limit - Standard", "type": "rate_limit", "allowed": false, "reason": "Rate limit exceeded: 101/100 per hour" }
  ]
}

15. Simulation Run

POST /simulation-run — Execute a multi-agent simulation scenario. Test coordination logic before deploying to production.

curl -X POST "https://agentsync-os.p.rapidapi.com/simulation-run" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: agentsync-os.p.rapidapi.com" \
  -H "x-api-key: ask_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario": {
      "name": "Three agents compete for one task",
      "agents": 3,
      "tasks": 1,
      "conflict_mode": "reputation_priority"
    },
    "steps": [
      { "action": "register", "count": 3 },
      { "action": "task-claim", "target": "task_sim_01" }
    ]
  }'

Response (200):

{
  "simulation_id": "sim_abc",
  "status": "completed",
  "results": {
    "winner": "sim_agent_3",
    "conflicts_detected": 2,
    "conflicts_resolved": 2,
    "total_time_ms": 340
  }
}

Response Standards

All responses are JSON with Content-Type: application/json
Every response includes an X-Request-Id header for tracing
Errors follow the format: { "error": "description" }
HTTP status codes: 200 (success), 201 (created), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 409 (conflict), 500 (server error)

Pricing Plans

Plan	Price	Requests/month	Rate Limit	Best For
Basic	$0/mo	500	10 req/min	Exploration & prototyping
Pro	$19/mo	10,000	50 req/min	Side projects & indie devs
Ultra	$49/mo	100,000	200 req/min	Production workloads
<Mega>Business	$149/mo	1,000,000	1,000 req/min	Teams & enterprise agents
Enterprise	Custom	Unlimited	Custom	Dedicated support & SLAs

What's included in every plan

All 15 endpoints — no feature gating
Full audit logging & telemetry
Agent reputation tracking
Policy engine access
Simulation sandbox

Overages

Free plan: hard cap. Paid plans: $0.002 per additional request beyond your monthly quota. No surprise bills — overage billing is opt-in via your RapidAPI dashboard.

Support

Email: agentsync@fastmail.com