Docs › Authentication

Authentication

How to authenticate requests to the Agent Readiness Platform API.

MVP Notice: The Agent Readiness Platform API currently does not require authentication. All endpoints are publicly accessible. API key authentication will be added in a future release.

API Base URL

All API requests should be made to the following base URL:

https://agentreadiness.net/api/v1

Request Format

The API accepts and returns JSON. Include the following headers on all requests that include a request body:

Header Value Required
Content-Type application/json Yes (for POST/PUT/PATCH)
Accept application/json Optional (default)

Example Request

A complete example request showing all recommended headers:

curl -X POST https://agentreadiness.net/api/v1/quick-eval \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "company_name": "YourProduct",
    "website_url": "https://yourproduct.com",
    "competitors": ["https://competitor1.com"],
    "task": "Set up email sending via API",
    "category": "email_api"
  }'

Example GET Request

GET requests do not require a Content-Type header:

curl https://agentreadiness.net/api/v1/evaluations/{evaluation_id}/status

Response Format

All API responses return JSON with appropriate HTTP status codes:

Status Code Meaning
200 Success
201 Created (resource was created successfully)
202 Accepted (async operation started)
400 Bad Request (invalid input)
404 Not Found (resource does not exist)
422 Validation Error (check request body)
500 Internal Server Error

Error Response Format

Error responses include a structured JSON body:

{
  "detail": "Evaluation not found",
  "status_code": 404
}

Rate Limits

The current MVP does not enforce rate limits. In future versions, rate limits will be applied per API key:

Future Authentication

Coming Soon: API key authentication will be required in a future release. When implemented, you will need to include an Authorization header with a Bearer token on all requests.

The planned authentication flow:

  1. Register at /api/v1/auth/register with your email
  2. Receive an API key
  3. Include the key in all requests: Authorization: Bearer your-api-key

Until auth is implemented, all endpoints are freely accessible. We recommend testing with the Quickstart guide.

CORS

The API allows cross-origin requests from all origins (*). This means you can call the API from any frontend application, browser extension, or AI agent without CORS issues.

Next Steps