Skip to main content
The Ayliea REST API provides programmatic access to your organization’s security posture data — assessment scores, recommendations, and AI discovery results. Use it to feed dashboards, trigger alerts in your SIEM, sync remediation tasks with your ticketing system, or build custom integrations.

​
Base URL

All API requests use the following base URL: 
https://assess.ayliea.com/api/v1
The API is versioned via the URL path. The current version is v1.

​
Key details

PropertyValue
ProtocolHTTPS only
FormatJSON request and response bodies
AuthAPI key via X-API-Key header
AvailabilityEnterprise tier only
CORSNot supported — server-to-server use only
TimestampsISO 8601 UTC (e.g., 2026-03-15T14:30:00Z)
Rate limit60 requests per minute per API key
The API is designed for server-to-server integration. API keys must never be exposed in client-side code, mobile apps, or browser requests.

​
Quick start

Get from zero to your first API call in three steps.
1

Create an API key

Navigate to Organization Settings and open the API Keys tab. Click Create Key, give it a label (e.g., “SIEM Integration”), select the scopes you need, and click Create.Copy the key immediately — it is shown only once.
2

Make your first request

Replace YOUR_API_KEY with the key you just copied:
curl https://assess.ayliea.com/api/v1/scores \
  -H "X-API-Key: ayliea_pk_YOUR_API_KEY"
3

Parse the response

A successful response returns JSON with your latest assessment scores:
{
  "scores": [
    {
      "framework_id": "ai-security",
      "overall_score": 72,
      "grade": "C",
      "completed_at": "2026-03-15T14:30:00Z"
    }
  ]
}

​
Available endpoints

Scores

Latest assessment scores per framework with grades and completion timestamps.

Recommendations

Prioritized remediation recommendations with status, framework, and category context.

Discovery

AI platform discovery scan results with detected platforms and confidence scores.

​
Next steps

Authentication

Learn how API keys work, how scopes are enforced, and how to rotate keys safely.

Errors

Understand error responses, HTTP status codes, and how to handle failures.