AEP API Reference

This page is a summary, not the full generated reference — a versioned, per-endpoint reference site is planned. Everything below is accurate today; it just isn't the final documentation format.

Authenticating

Every request needs an API key generated from Account Settings → API Keys, passed as the AEP_API_KEY environment variable or a bearer token — see the CLI quickstart for the exact setup steps.

REST endpoints

The API surface a request or automation script calls into for triggering and monitoring skill runs, mirroring what the CLI itself uses under the hood:

POST /skills/{skill}/run — trigger a skill run against a connected project
GET /skills/{skill}/runs/{run_id} — poll a run's status
GET /skills/{skill}/runs/{run_id}/output — retrieve a completed run's output
GET /skills — list skills available to your account

WebSocket streaming

For long-running skill runs, a WebSocket connection at /skills/{skill}/runs/{run_id}/stream streams progress events as they happen, instead of polling the REST status endpoint.

Next steps

Getting started with the CLI first: AEP CLI quickstart.
Connecting third-party tools instead of writing your own client: Integration guides.