API

Overview

The Asiyst REST API provides programmatic access to every platform resource. You can automate project provisioning, create avatars, trigger knowledge re-indexing, and query conversation transcripts from your backend servers.

Base URL & Conventions

All API requests are made over HTTPS to:

https://api.asiyst.com/api/v1

• Format: Requests and responses use application/json.

• Timestamps: All dates are formatted as ISO 8601 strings in UTC (2026-09-21T12:00:00.000Z).

• Idempotency: Pass an Idempotency-Key: header on POST requests to prevent duplicate resource creation.

Authentication Header

Authenticate server requests using a secret API Key:

curl -X GET https://api.asiyst.com/api/v1/projects \
  -H "Authorization: Bearer sk_live_your_secret_key"

Response Envelope

Successful requests return a standardized JSON envelope:

{
  "success": true,
  "data": {
    "id": "proj_9f8a2b3c4d",
    "name": "Production Store",
    "status": "active"
  }
}

Errors return descriptive error structures:

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key prefix provided."
  }
}

Explore API Overview or the complete API Reference.