API

API Overview

Use the Asiyst REST API to manage projects, assistants, knowledge bases, conversations, and events programmatically.

Overview

The Asiyst REST API provides programmatic control over the entire Asiyst platform. Use the API to automate workspace provisioning, synchronize knowledge vector stores from CMS webhooks, extract conversation transcripts for internal compliance audits, and deploy assistant prompt updates.

Base URL & Conventions

https://asiyst.com/api/v1

All API endpoints strictly require HTTPS. Plain HTTP calls are rejected with 301 Moved Permanently.

All request and response bodies use application/json encoding.

Dates and timestamps are formatted as ISO 8601 strings in UTC (YYYY-MM-DDTHH:mm:ssZ).

Standard JSON Envelope

Successful responses return a structured data payload with request metadata:

{
  "data": {
    "id": "proj_9f8a2b3c4d",
    "name": "Production Docs Assistant",
    "status": "active"
  },
  "meta": {
    "requestId": "req_01h8x9a2b",
    "timestamp": "2026-09-28T04:15:00Z"
  }
}

HTTP Methods & Status Codes

Method	Purpose	Successful Status
`GET`	Retrieve resources	`200 OK`
`POST`	Create new resource	`201 Created`
`PATCH` / `PUT`	Update existing resource	`200 OK`
`DELETE`	Delete resource	`200 OK` or `204 No Content`

Docs/API

API