API Reference

API Overview

The NeuraFlow REST API provides programmatic access to all platform resources including projects, automations, runs, and team management. All endpoints require authentication via API key or OAuth 2.0 bearer token.

Authentication

Include your API key in the Authorization header of every request. You can generate API keys from Settings > API Keys in the dashboard.

curl https://api.neuraflow.io/v1/projects \
  -H 'Authorization: Bearer nf_live_abc123xyz789'

Projects Endpoint

GET    /v1/projects          List all projects
POST   /v1/projects          Create a new project
GET    /v1/projects/:id      Get project details
PATCH  /v1/projects/:id      Update a project
DELETE /v1/projects/:id      Delete a project

Automations Endpoint

GET    /v1/automations              List automations
POST   /v1/automations              Create automation
GET    /v1/automations/:id          Get automation details
PATCH  /v1/automations/:id          Update automation
POST   /v1/automations/:id/enable   Enable automation
POST   /v1/automations/:id/disable  Disable automation

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with an error code, message, and optional details array for validation errors.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request body",
    "details": [
      { "field": "name", "message": "Name is required" },
      { "field": "trigger.type", "message": "Invalid trigger type" }
    ]
  }
}