Elydora Docs

API Reference

Complete HTTP API documentation for the Elydora platform. All endpoints use JSON request and response bodies.

Base URL

https://api.elydora.com

Authentication

Most endpoints require a Bearer token in the Authorization header: a Better Auth session token or an API token issued through POST /v1/auth/token.

http
Authorization: Bearer <your-session-token>

Error Format

All errors return a consistent JSON structure with an error code and human-readable message. See the full list of error codes.

json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "request_id": "019605a3-7b2c-7d00-8000-abcdef123456"
  }
}

Pagination

POST /v1/audit/query accepts cursor and limit in the request body and returns a cursor when more results exist. GET /v1/admin/events accepts a limit query parameter.

json
{
  "operations": [...],
  "cursor": "<opaque cursor>",
  "total_count": 42
}

Endpoint Overview

POST
/api/auth/sign-up/email
Sign up with email and password
POST
/api/auth/sign-in/email
Sign in and receive a session token
GET
/api/auth/get-session
Get the Better Auth session
Auth: Optional
GET
/v1/auth/me
Get the current user and organization
Auth: Any authenticated user
POST
/v1/auth/refresh
Issue a new session token
Auth: Session token
POST
/v1/auth/token
Issue an API token
Auth: Session token
POST
/v1/auth/rotate
Rotate the current API token
Auth: API token
GET
/v1/onboarding/status
Check onboarding completion status
Auth: Any authenticated user
POST
/v1/onboarding/personal
Create a personal workspace
Auth: Any authenticated user
POST
/v1/onboarding/organization
Create an organization workspace with invitations
Auth: Any authenticated user
POST
/v1/agents/register
Register a new agent
Auth: org_owner, security_admin, integration_engineer
GET
/v1/agents
List the agents visible to the caller
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
GET
/v1/agents/:agent_id
Get agent details
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
PATCH
/v1/agents/:agent_id
Update agent integration type
Auth: org_owner, security_admin, integration_engineer
DELETE
/v1/agents/:agent_id
Delete an agent
Auth: org_owner, security_admin
POST
/v1/agents/:agent_id/freeze
Freeze an agent
Auth: org_owner, security_admin
POST
/v1/agents/:agent_id/unfreeze
Unfreeze an agent
Auth: org_owner, security_admin
POST
/v1/agents/:agent_id/revoke
Revoke an agent key
Auth: org_owner, security_admin
GET
/v1/agents/:agent_id/assignments
List users assigned to an agent
Auth: org_owner, security_admin
POST
/v1/agents/:agent_id/assignments
Assign a user to an agent
Auth: org_owner, security_admin
DELETE
/v1/agents/:agent_id/assignments/:user_id
Remove a user from an agent
Auth: org_owner, security_admin
POST
/v1/operations
Submit a signed operation
Auth: org_owner, security_admin, integration_engineer
GET
/v1/operations/:operation_id
Retrieve an operation record
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
POST
/v1/operations/:operation_id/verify
Verify operation integrity
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
POST
/v1/audit/query
Query audit records
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/admin/events
List recent admin audit events
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/epochs
List epochs
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
GET
/v1/epochs/:epoch_id
Get epoch details
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
POST
/v1/exports
Create an export job
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/exports
List export jobs
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/exports/:export_id
Get export status
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/exports/:export_id/download
Download export data
Auth: org_owner, security_admin, compliance_auditor
GET
/v1/members
List organization members
Auth: org_owner, security_admin, compliance_auditor, integration_engineer, readonly_investigator
GET
/v1/members/invitations
List pending invitations
Auth: org_owner, security_admin
GET
/v1/members/:user_id/agents
List agents assigned to a user
Auth: Self, org_owner, security_admin
GET
/v1/webhooks
List registered webhooks
Auth: org_owner, security_admin
POST
/v1/webhooks
Register a new webhook endpoint
Auth: org_owner, security_admin
DELETE
/v1/webhooks/:webhook_id
Delete a webhook
Auth: org_owner, security_admin
GET
/.well-known/elydora/jwks.json
Public JWKS endpoint
GET
/v1/health
Health check
GET
/v1/health/deep
Deep health check with dependency status