API Overview

The Studio server exposes the same REST API that the web UI uses. This document is for integration developers who want to call that API directly.

Base Address

All paths begin with /api under the Studio server address.

https://<studio-host>/api/...

Authentication

Send the session token as a header.

Authorization: Bearer <token>

If the token is missing or expired, the server returns 401. When the web UI receives a 401, it clears the stored token and returns to the login screen. The same handling is recommended for direct calls — a 401 will not resolve itself on retry.

Response Format

Successful responses arrive wrapped in a data envelope.

{
  "data": { "id": "prj_01H...", "name": "라인 모니터" }
}

Failed responses contain a errors array. The message of the first item is the human-readable message.

{
  "errors": [
    { "code": "project_not_found", "message": "프로젝트를 찾을 수 없습니다." }
  ]
}

Clients should check the HTTP status together with errors[0].message. Since the server sometimes returns no message, the web UI uses its own fallback text only in that case.

Streaming Events

Progress while the agent is working arrives as a stream. This applies to conversations (/api/session/{id}/message, /api/ask) and notifications (/api/notifications/stream).

There are seven events.

type	Value carried	Meaning
assistant_text	text	A text fragment written by the agent
tool_call	name, input	A tool was called
tool_result	name, ok, summary	Tool result. ok indicates success
file_change	path	A file changed
commit	hash, message	The change was committed
done	—	This turn has ended
error	message	An error during processing

Read until done or error arrives.

Attachments

Attachments such as images are sent inline as base64.

{
  "name": "설비사진.png",
  "mime": "image/png",
  "dataBase64": "iVBORw0KGgo..."
}

Document Structure

Document	Covers
Session	Work session lifecycle, files, history, undo
Projects and Deployment	App creation, deployment, rollback, runtime
Chat	Conversations with the agent, query history
Skills	Field skill registration, extraction, import
Platform Integration	PlantPulse platform data exploration, semantic search
Administration	Settings, users, watchers, auditing, notifications