Skip to content

api.md

Latest commit

 

History

History
388 lines (324 loc) · 6.65 KB

api.md

File metadata and controls

388 lines (324 loc) · 6.65 KB

Fleet Pi API Reference

Generated from openapi.json.

Start with docs/README.md and docs/quickstart.md if you are new to the project. This file is generated reference material.

Base URL: http://localhost:3000

POST /api/chat

Send a chat message and receive a streaming response

Request Body

{
  "sessionFile": <string>,
  "sessionId": <string>,
  "message": <string> — User message,
  "model": — Selected model,
  "mode": <string> — Chat mode,
  "planAction": <string> — Plan action,
  "streamingBehavior": <string> — Streaming behavior
}

Responses

  • 200 — NDJSON stream of chat events One of: 
    {
  "type": <string> (required),
  "id": <string> (required),
  "runId": <string> (required),
  "sessionFile": <string>,
  "sessionId": <string> (required),
  "sessionReset": <boolean>,
  "diagnostics": <array>
}
    {
  "type": <string> (required),
  "text": <string> (required),
  "messageId": <string>
}
    {
  "type": <string> (required),
  "part": <object> (required) — Tool message part,
  "messageId": <string>
}
    {
  "type": <string> (required),
  "mode": <string> (required) — Chat mode,
  "executing": <boolean> (required),
  "completed": <number> (required),
  "total": <number> (required),
  "message": <string>,
  "state": <object> (required) — Structured plan state
}
    {
  "type": <string> (required),
  "state": <object> (required) — Chat state event
}
    {
  "type": <string> (required),
  "steering": <array> (required),
  "followUp": <array> (required)
}
    {
  "type": <string> (required),
  "text": <string> (required),
  "messageId": <string>
}
    {
  "type": <string> (required),
  "phase": <string> (required),
  "reason": <string> (required)
}
    {
  "type": <string> (required),
  "phase": <string> (required),
  "reason": <string> (required),
  "aborted": <boolean> (required),
  "willRetry": <boolean> (required),
  "errorMessage": <string>
}
    {
  "type": <string> (required),
  "phase": <string> (required),
  "attempt": <number> (required),
  "maxAttempts": <number> (required),
  "delayMs": <number> (required),
  "errorMessage": <string> (required)
}
    {
  "type": <string> (required),
  "phase": <string> (required),
  "success": <boolean> (required),
  "attempt": <number> (required),
  "finalError": <string>
}
    {
  "type": <string> (required),
  "runId": <string> (required),
  "message": <object> (required) — Chat message,
  "sessionFile": <string>,
  "sessionId": <string> (required),
  "sessionReset": <boolean>
}
    {
  "type": <string> (required),
  "message": <string> (required),
  "runId": <string>
}
  • 400 — Bad request Type: string

GET /api/chat/models

List available chat models

Responses

  • 200 — List of models 
    {
  "models": <array> (required),
  "selectedModelKey": <string>,
  "defaultProvider": <string>,
  "defaultModel": <string>,
  "defaultThinkingLevel": <string> — Thinking level,
  "diagnostics": <array> (required)
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

GET /api/chat/resources

List available chat resources (skills, prompts, extensions)

Responses

  • 200 — List of resources 
    {
  "packages": <array> (required),
  "skills": <array> (required),
  "prompts": <array> (required),
  "extensions": <array> (required),
  "themes": <array> (required),
  "agentsFiles": <array> (required),
  "diagnostics": <array> (required)
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

GET /api/chat/session

Hydrate a chat session by query parameters

Parameters

Name In Required Description
sessionFile query No Session file path
sessionId query No Session ID

Responses

  • 200 — Session data 
    {
  "session": <object> (required) — Chat session metadata,
  "messages": <array> (required),
  "sessionReset": <boolean>
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

GET /api/chat/sessions

List all chat sessions

Responses

  • 200 — List of sessions 
    {
  "sessions": <array> (required)
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

POST /api/chat/new

Create a new chat session

Responses

  • 200 — New session metadata 
    {
  "sessionFile": <string> — Session file path,
  "sessionId": <string> — Session ID
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

POST /api/chat/resume

Resume an existing chat session

Request Body

{
  "sessionFile": <string> — Session file path,
  "sessionId": <string> — Session ID
}

Responses

  • 200 — Session data 
    {
  "session": <object> (required) — Chat session metadata,
  "messages": <array> (required),
  "sessionReset": <boolean>
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

POST /api/chat/abort

Abort the active chat session

Request Body

{
  "sessionFile": <string> — Session file path,
  "sessionId": <string> — Session ID
}

Responses

  • 200 — Abort result 
    {
  "aborted": <boolean> (required)
}
  • 500 — Server error 
    {
  "message": <string> (required)
}

POST /api/chat/question

Answer a question prompt from the assistant

Request Body

{
  "sessionFile": <string>,
  "sessionId": <string>,
  "toolCallId": <string>,
  "answer": <object> (required) — Question answer
}

Responses

  • 200 — Answer processed 
    {
  "ok": <boolean> (required),
  "message": <string>,
  "mode": <string> — Chat mode,
  "planAction": <string> — Plan action
}
  • 400 — Bad request Type: string
  • 404 — Not found 
    {
  "ok": <boolean> (required),
  "message": <string>,
  "mode": <string> — Chat mode,
  "planAction": <string> — Plan action
}

GET /api/health

Health check endpoint

Responses

  • 200 — Service is healthy 
    {
  "status": <string> (required)
}