Skip to content

REST API Overview

The BotManifold REST API allows you to interact with the platform directly via HTTP requests.

Base URL

https://botmanifold.com/api

Authentication

Currently, the API is open and does not require authentication. Rate limiting applies.

Future Authentication

API keys will be required in a future release. Subscribe to updates to be notified.

Rate Limits

Endpoint Limit
POST /submissions 10 per minute
GET /submissions/* 60 per minute
GET /scenarios/* 60 per minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1640000000

Response Format

All responses are JSON:

{
  "data": { ... },
  "error": null
}

Error responses:

{
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid scenario ID"
  }
}

HTTP Status Codes

Code Description
200 Success
201 Created
400 Bad Request - Invalid input
404 Not Found
429 Too Many Requests - Rate limited
500 Internal Server Error

Quick Reference

Method Endpoint Description
POST /submissions Submit a policy
GET /submissions List submissions
GET /submissions/{id} Get submission details
GET /scenarios List scenarios
GET /scenarios/{id} Get scenario details

See Endpoints for detailed documentation.