agent-remote-server-core / Exports
agent-remote-server-core
Table of contents
Interfaces
Variables
Functions
Variables
REMOTE_OPENAPI_DOCUMENT
• Const REMOTE_OPENAPI_DOCUMENT: Object
Type declaration
| Name | Type |
|---|---|
openapi | "3.0.3" |
info | { title: "Robota Remote API" = 'Robota Remote API'; version: "1.0.0" = '1.0.0'; description: "LLM provider proxy API exposed by the Remote server." = 'LLM provider proxy API exposed by the Remote server.' } |
info.title | "Robota Remote API" |
info.version | "1.0.0" |
info.description | "LLM provider proxy API exposed by the Remote server." |
servers | readonly [{ url: "/" = '/' }] |
tags | readonly [{ name: "Remote" = 'Remote' }] |
components | { schemas: { ChatMessage: { type: "object" = 'object'; required: readonly ["role", "content"] ; properties: { role: { type: "string" = 'string'; description: "Message role (e.g., user, assistant, system)." = 'Message role (e.g., user, assistant, system).' } ; content: { type: "string" = 'string' } ; toolCalls: { type: "array" = 'array'; items: { type: "object" = 'object' } } ; toolCallId: { type: "string" = 'string' } } } ; ChatRequest: { type: "object" = 'object'; required: readonly ["provider", "model", "messages"] ; properties: { provider: { type: "string" = 'string'; description: "LLM provider identifier (e.g., openai, anthropic)." = 'LLM provider identifier (e.g., openai, anthropic).' } ; model: { type: "string" = 'string'; description: "Model identifier (e.g., gpt-4, claude-3)." = 'Model identifier (e.g., gpt-4, claude-3).' } ; messages: { type: "array" = 'array'; items: { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } ; description: "Conversation message history." = 'Conversation message history.' } ; tools: { type: "array" = 'array'; items: { type: "object" = 'object' } ; description: "Optional tool schemas for function calling." = 'Optional tool schemas for function calling.' } ; temperature: { type: "number" = 'number' } ; maxTokens: { type: "number" = 'number' } } } ; ChatResponse: { type: "object" = 'object'; required: readonly ["success", "data", "provider", "model", "timestamp"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; data: { type: "object" = 'object'; description: "Universal message response from the provider." = 'Universal message response from the provider.' } ; provider: { type: "string" = 'string' } ; model: { type: "string" = 'string' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } ; ChatErrorResponse: { type: "object" = 'object'; required: readonly ["error", "message"] ; properties: { error: { type: "string" = 'string' } ; message: { type: "string" = 'string' } } } ; ProviderCapabilities: { type: "object" = 'object'; required: readonly ["success", "provider", "capabilities"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; provider: { type: "string" = 'string' } ; capabilities: { type: "object" = 'object'; required: readonly ["chat", "stream", "tools"] ; properties: { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } } } } ; ProviderNotFoundResponse: { type: "object" = 'object'; required: readonly ["error", "availableProviders"] ; properties: { error: { type: "string" = 'string' } ; availableProviders: { type: "array" = 'array'; items: { type: "string" = 'string' } } } } ; HealthResponse: { type: "object" = 'object'; required: readonly ["status", "service", "initialized", "providers", "providerCount", "timestamp"] ; properties: { status: { type: "string" = 'string'; enum: readonly ["ok"] } ; service: { type: "string" = 'string' } ; initialized: { type: "boolean" = 'boolean' } ; providers: { type: "array" = 'array'; items: { type: "string" = 'string' } } ; providerCount: { type: "number" = 'number' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } } } |
components.schemas | { ChatMessage: { type: "object" = 'object'; required: readonly ["role", "content"] ; properties: { role: { type: "string" = 'string'; description: "Message role (e.g., user, assistant, system)." = 'Message role (e.g., user, assistant, system).' } ; content: { type: "string" = 'string' } ; toolCalls: { type: "array" = 'array'; items: { type: "object" = 'object' } } ; toolCallId: { type: "string" = 'string' } } } ; ChatRequest: { type: "object" = 'object'; required: readonly ["provider", "model", "messages"] ; properties: { provider: { type: "string" = 'string'; description: "LLM provider identifier (e.g., openai, anthropic)." = 'LLM provider identifier (e.g., openai, anthropic).' } ; model: { type: "string" = 'string'; description: "Model identifier (e.g., gpt-4, claude-3)." = 'Model identifier (e.g., gpt-4, claude-3).' } ; messages: { type: "array" = 'array'; items: { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } ; description: "Conversation message history." = 'Conversation message history.' } ; tools: { type: "array" = 'array'; items: { type: "object" = 'object' } ; description: "Optional tool schemas for function calling." = 'Optional tool schemas for function calling.' } ; temperature: { type: "number" = 'number' } ; maxTokens: { type: "number" = 'number' } } } ; ChatResponse: { type: "object" = 'object'; required: readonly ["success", "data", "provider", "model", "timestamp"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; data: { type: "object" = 'object'; description: "Universal message response from the provider." = 'Universal message response from the provider.' } ; provider: { type: "string" = 'string' } ; model: { type: "string" = 'string' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } ; ChatErrorResponse: { type: "object" = 'object'; required: readonly ["error", "message"] ; properties: { error: { type: "string" = 'string' } ; message: { type: "string" = 'string' } } } ; ProviderCapabilities: { type: "object" = 'object'; required: readonly ["success", "provider", "capabilities"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; provider: { type: "string" = 'string' } ; capabilities: { type: "object" = 'object'; required: readonly ["chat", "stream", "tools"] ; properties: { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } } } } ; ProviderNotFoundResponse: { type: "object" = 'object'; required: readonly ["error", "availableProviders"] ; properties: { error: { type: "string" = 'string' } ; availableProviders: { type: "array" = 'array'; items: { type: "string" = 'string' } } } } ; HealthResponse: { type: "object" = 'object'; required: readonly ["status", "service", "initialized", "providers", "providerCount", "timestamp"] ; properties: { status: { type: "string" = 'string'; enum: readonly ["ok"] } ; service: { type: "string" = 'string' } ; initialized: { type: "boolean" = 'boolean' } ; providers: { type: "array" = 'array'; items: { type: "string" = 'string' } } ; providerCount: { type: "number" = 'number' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } } |
components.schemas.ChatMessage | { type: "object" = 'object'; required: readonly ["role", "content"] ; properties: { role: { type: "string" = 'string'; description: "Message role (e.g., user, assistant, system)." = 'Message role (e.g., user, assistant, system).' } ; content: { type: "string" = 'string' } ; toolCalls: { type: "array" = 'array'; items: { type: "object" = 'object' } } ; toolCallId: { type: "string" = 'string' } } } |
components.schemas.ChatMessage.type | "object" |
components.schemas.ChatMessage.required | readonly ["role", "content"] |
components.schemas.ChatMessage.properties | { role: { type: "string" = 'string'; description: "Message role (e.g., user, assistant, system)." = 'Message role (e.g., user, assistant, system).' } ; content: { type: "string" = 'string' } ; toolCalls: { type: "array" = 'array'; items: { type: "object" = 'object' } } ; toolCallId: { type: "string" = 'string' } } |
components.schemas.ChatMessage.properties.role | { type: "string" = 'string'; description: "Message role (e.g., user, assistant, system)." = 'Message role (e.g., user, assistant, system).' } |
components.schemas.ChatMessage.properties.role.type | "string" |
components.schemas.ChatMessage.properties.role.description | "Message role (e.g., user, assistant, system)." |
components.schemas.ChatMessage.properties.content | { type: "string" = 'string' } |
components.schemas.ChatMessage.properties.content.type | "string" |
components.schemas.ChatMessage.properties.toolCalls | { type: "array" = 'array'; items: { type: "object" = 'object' } } |
components.schemas.ChatMessage.properties.toolCalls.type | "array" |
components.schemas.ChatMessage.properties.toolCalls.items | { type: "object" = 'object' } |
components.schemas.ChatMessage.properties.toolCalls.items.type | "object" |
components.schemas.ChatMessage.properties.toolCallId | { type: "string" = 'string' } |
components.schemas.ChatMessage.properties.toolCallId.type | "string" |
components.schemas.ChatRequest | { type: "object" = 'object'; required: readonly ["provider", "model", "messages"] ; properties: { provider: { type: "string" = 'string'; description: "LLM provider identifier (e.g., openai, anthropic)." = 'LLM provider identifier (e.g., openai, anthropic).' } ; model: { type: "string" = 'string'; description: "Model identifier (e.g., gpt-4, claude-3)." = 'Model identifier (e.g., gpt-4, claude-3).' } ; messages: { type: "array" = 'array'; items: { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } ; description: "Conversation message history." = 'Conversation message history.' } ; tools: { type: "array" = 'array'; items: { type: "object" = 'object' } ; description: "Optional tool schemas for function calling." = 'Optional tool schemas for function calling.' } ; temperature: { type: "number" = 'number' } ; maxTokens: { type: "number" = 'number' } } } |
components.schemas.ChatRequest.type | "object" |
components.schemas.ChatRequest.required | readonly ["provider", "model", "messages"] |
components.schemas.ChatRequest.properties | { provider: { type: "string" = 'string'; description: "LLM provider identifier (e.g., openai, anthropic)." = 'LLM provider identifier (e.g., openai, anthropic).' } ; model: { type: "string" = 'string'; description: "Model identifier (e.g., gpt-4, claude-3)." = 'Model identifier (e.g., gpt-4, claude-3).' } ; messages: { type: "array" = 'array'; items: { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } ; description: "Conversation message history." = 'Conversation message history.' } ; tools: { type: "array" = 'array'; items: { type: "object" = 'object' } ; description: "Optional tool schemas for function calling." = 'Optional tool schemas for function calling.' } ; temperature: { type: "number" = 'number' } ; maxTokens: { type: "number" = 'number' } } |
components.schemas.ChatRequest.properties.provider | { type: "string" = 'string'; description: "LLM provider identifier (e.g., openai, anthropic)." = 'LLM provider identifier (e.g., openai, anthropic).' } |
components.schemas.ChatRequest.properties.provider.type | "string" |
components.schemas.ChatRequest.properties.provider.description | "LLM provider identifier (e.g., openai, anthropic)." |
components.schemas.ChatRequest.properties.model | { type: "string" = 'string'; description: "Model identifier (e.g., gpt-4, claude-3)." = 'Model identifier (e.g., gpt-4, claude-3).' } |
components.schemas.ChatRequest.properties.model.type | "string" |
components.schemas.ChatRequest.properties.model.description | "Model identifier (e.g., gpt-4, claude-3)." |
components.schemas.ChatRequest.properties.messages | { type: "array" = 'array'; items: { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } ; description: "Conversation message history." = 'Conversation message history.' } |
components.schemas.ChatRequest.properties.messages.type | "array" |
components.schemas.ChatRequest.properties.messages.items | { $ref: "#/components/schemas/ChatMessage" = '#/components/schemas/ChatMessage' } |
components.schemas.ChatRequest.properties.messages.items.$ref | "#/components/schemas/ChatMessage" |
components.schemas.ChatRequest.properties.messages.description | "Conversation message history." |
components.schemas.ChatRequest.properties.tools | { type: "array" = 'array'; items: { type: "object" = 'object' } ; description: "Optional tool schemas for function calling." = 'Optional tool schemas for function calling.' } |
components.schemas.ChatRequest.properties.tools.type | "array" |
components.schemas.ChatRequest.properties.tools.items | { type: "object" = 'object' } |
components.schemas.ChatRequest.properties.tools.items.type | "object" |
components.schemas.ChatRequest.properties.tools.description | "Optional tool schemas for function calling." |
components.schemas.ChatRequest.properties.temperature | { type: "number" = 'number' } |
components.schemas.ChatRequest.properties.temperature.type | "number" |
components.schemas.ChatRequest.properties.maxTokens | { type: "number" = 'number' } |
components.schemas.ChatRequest.properties.maxTokens.type | "number" |
components.schemas.ChatResponse | { type: "object" = 'object'; required: readonly ["success", "data", "provider", "model", "timestamp"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; data: { type: "object" = 'object'; description: "Universal message response from the provider." = 'Universal message response from the provider.' } ; provider: { type: "string" = 'string' } ; model: { type: "string" = 'string' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } |
components.schemas.ChatResponse.type | "object" |
components.schemas.ChatResponse.required | readonly ["success", "data", "provider", "model", "timestamp"] |
components.schemas.ChatResponse.properties | { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; data: { type: "object" = 'object'; description: "Universal message response from the provider." = 'Universal message response from the provider.' } ; provider: { type: "string" = 'string' } ; model: { type: "string" = 'string' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } |
components.schemas.ChatResponse.properties.success | { type: "boolean" = 'boolean'; enum: readonly [true] } |
components.schemas.ChatResponse.properties.success.type | "boolean" |
components.schemas.ChatResponse.properties.success.enum | readonly [true] |
components.schemas.ChatResponse.properties.data | { type: "object" = 'object'; description: "Universal message response from the provider." = 'Universal message response from the provider.' } |
components.schemas.ChatResponse.properties.data.type | "object" |
components.schemas.ChatResponse.properties.data.description | "Universal message response from the provider." |
components.schemas.ChatResponse.properties.provider | { type: "string" = 'string' } |
components.schemas.ChatResponse.properties.provider.type | "string" |
components.schemas.ChatResponse.properties.model | { type: "string" = 'string' } |
components.schemas.ChatResponse.properties.model.type | "string" |
components.schemas.ChatResponse.properties.timestamp | { type: "string" = 'string'; format: "date-time" = 'date-time' } |
components.schemas.ChatResponse.properties.timestamp.type | "string" |
components.schemas.ChatResponse.properties.timestamp.format | "date-time" |
components.schemas.ChatErrorResponse | { type: "object" = 'object'; required: readonly ["error", "message"] ; properties: { error: { type: "string" = 'string' } ; message: { type: "string" = 'string' } } } |
components.schemas.ChatErrorResponse.type | "object" |
components.schemas.ChatErrorResponse.required | readonly ["error", "message"] |
components.schemas.ChatErrorResponse.properties | { error: { type: "string" = 'string' } ; message: { type: "string" = 'string' } } |
components.schemas.ChatErrorResponse.properties.error | { type: "string" = 'string' } |
components.schemas.ChatErrorResponse.properties.error.type | "string" |
components.schemas.ChatErrorResponse.properties.message | { type: "string" = 'string' } |
components.schemas.ChatErrorResponse.properties.message.type | "string" |
components.schemas.ProviderCapabilities | { type: "object" = 'object'; required: readonly ["success", "provider", "capabilities"] ; properties: { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; provider: { type: "string" = 'string' } ; capabilities: { type: "object" = 'object'; required: readonly ["chat", "stream", "tools"] ; properties: { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } } } } |
components.schemas.ProviderCapabilities.type | "object" |
components.schemas.ProviderCapabilities.required | readonly ["success", "provider", "capabilities"] |
components.schemas.ProviderCapabilities.properties | { success: { type: "boolean" = 'boolean'; enum: readonly [true] } ; provider: { type: "string" = 'string' } ; capabilities: { type: "object" = 'object'; required: readonly ["chat", "stream", "tools"] ; properties: { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } } } |
components.schemas.ProviderCapabilities.properties.success | { type: "boolean" = 'boolean'; enum: readonly [true] } |
components.schemas.ProviderCapabilities.properties.success.type | "boolean" |
components.schemas.ProviderCapabilities.properties.success.enum | readonly [true] |
components.schemas.ProviderCapabilities.properties.provider | { type: "string" = 'string' } |
components.schemas.ProviderCapabilities.properties.provider.type | "string" |
components.schemas.ProviderCapabilities.properties.capabilities | { type: "object" = 'object'; required: readonly ["chat", "stream", "tools"] ; properties: { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } } |
components.schemas.ProviderCapabilities.properties.capabilities.type | "object" |
components.schemas.ProviderCapabilities.properties.capabilities.required | readonly ["chat", "stream", "tools"] |
components.schemas.ProviderCapabilities.properties.capabilities.properties | { chat: { type: "boolean" = 'boolean' } ; stream: { type: "boolean" = 'boolean' } ; tools: { type: "boolean" = 'boolean' } } |
components.schemas.ProviderCapabilities.properties.capabilities.properties.chat | { type: "boolean" = 'boolean' } |
components.schemas.ProviderCapabilities.properties.capabilities.properties.chat.type | "boolean" |
components.schemas.ProviderCapabilities.properties.capabilities.properties.stream | { type: "boolean" = 'boolean' } |
components.schemas.ProviderCapabilities.properties.capabilities.properties.stream.type | "boolean" |
components.schemas.ProviderCapabilities.properties.capabilities.properties.tools | { type: "boolean" = 'boolean' } |
components.schemas.ProviderCapabilities.properties.capabilities.properties.tools.type | "boolean" |
components.schemas.ProviderNotFoundResponse | { type: "object" = 'object'; required: readonly ["error", "availableProviders"] ; properties: { error: { type: "string" = 'string' } ; availableProviders: { type: "array" = 'array'; items: { type: "string" = 'string' } } } } |
components.schemas.ProviderNotFoundResponse.type | "object" |
components.schemas.ProviderNotFoundResponse.required | readonly ["error", "availableProviders"] |
components.schemas.ProviderNotFoundResponse.properties | { error: { type: "string" = 'string' } ; availableProviders: { type: "array" = 'array'; items: { type: "string" = 'string' } } } |
components.schemas.ProviderNotFoundResponse.properties.error | { type: "string" = 'string' } |
components.schemas.ProviderNotFoundResponse.properties.error.type | "string" |
components.schemas.ProviderNotFoundResponse.properties.availableProviders | { type: "array" = 'array'; items: { type: "string" = 'string' } } |
components.schemas.ProviderNotFoundResponse.properties.availableProviders.type | "array" |
components.schemas.ProviderNotFoundResponse.properties.availableProviders.items | { type: "string" = 'string' } |
components.schemas.ProviderNotFoundResponse.properties.availableProviders.items.type | "string" |
components.schemas.HealthResponse | { type: "object" = 'object'; required: readonly ["status", "service", "initialized", "providers", "providerCount", "timestamp"] ; properties: { status: { type: "string" = 'string'; enum: readonly ["ok"] } ; service: { type: "string" = 'string' } ; initialized: { type: "boolean" = 'boolean' } ; providers: { type: "array" = 'array'; items: { type: "string" = 'string' } } ; providerCount: { type: "number" = 'number' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } } |
components.schemas.HealthResponse.type | "object" |
components.schemas.HealthResponse.required | readonly ["status", "service", "initialized", "providers", "providerCount", "timestamp"] |
components.schemas.HealthResponse.properties | { status: { type: "string" = 'string'; enum: readonly ["ok"] } ; service: { type: "string" = 'string' } ; initialized: { type: "boolean" = 'boolean' } ; providers: { type: "array" = 'array'; items: { type: "string" = 'string' } } ; providerCount: { type: "number" = 'number' } ; timestamp: { type: "string" = 'string'; format: "date-time" = 'date-time' } } |
components.schemas.HealthResponse.properties.status | { type: "string" = 'string'; enum: readonly ["ok"] } |
components.schemas.HealthResponse.properties.status.type | "string" |
components.schemas.HealthResponse.properties.status.enum | readonly ["ok"] |
components.schemas.HealthResponse.properties.service | { type: "string" = 'string' } |
components.schemas.HealthResponse.properties.service.type | "string" |
components.schemas.HealthResponse.properties.initialized | { type: "boolean" = 'boolean' } |
components.schemas.HealthResponse.properties.initialized.type | "boolean" |
components.schemas.HealthResponse.properties.providers | { type: "array" = 'array'; items: { type: "string" = 'string' } } |
components.schemas.HealthResponse.properties.providers.type | "array" |
components.schemas.HealthResponse.properties.providers.items | { type: "string" = 'string' } |
components.schemas.HealthResponse.properties.providers.items.type | "string" |
components.schemas.HealthResponse.properties.providerCount | { type: "number" = 'number' } |
components.schemas.HealthResponse.properties.providerCount.type | "number" |
components.schemas.HealthResponse.properties.timestamp | { type: "string" = 'string'; format: "date-time" = 'date-time' } |
components.schemas.HealthResponse.properties.timestamp.type | "string" |
components.schemas.HealthResponse.properties.timestamp.format | "date-time" |
paths | { /api/v1/remote/health: { get: { tags: readonly ["Remote"] ; summary: "Remote server health" = 'Remote server health'; responses: { 200: { description: "OK" = 'OK'; content: { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } } } } } ; /api/v1/remote/chat: { post: { tags: readonly ["Remote"] ; summary: "Chat completion proxy" = 'Chat completion proxy'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Chat response" = 'Chat response'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } } ; 400: { description: "Invalid request (missing provider, model, or messages)" = 'Invalid request (missing provider, model, or messages)'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider error" = 'Provider error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } } ; /api/v1/remote/stream: { post: { tags: readonly ["Remote"] ; summary: "Streaming chat proxy" = 'Streaming chat proxy'; description: "Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`." = 'Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`.'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Streaming response via SSE" = 'Streaming response via SSE'; content: { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } } ; 400: { description: "Invalid request" = 'Invalid request'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider/streaming error" = 'Provider/streaming error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } } ; /api/v1/remote/providers/{provider}/capabilities: { get: { tags: readonly ["Remote"] ; summary: "Provider capability query" = 'Provider capability query'; parameters: readonly [{ name: "provider" = 'provider'; in: "path" = 'path'; required: true = true; schema: { type: "string" = 'string' } ; description: "Provider identifier." = 'Provider identifier.' }] ; responses: { 200: { description: "Capability payload" = 'Capability payload'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } } ; 404: { description: "Provider not found" = 'Provider not found'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } } } } } ; /api/v1/remote/ws/status: { get: { tags: readonly ["Remote"] ; summary: "Playground websocket status" = 'Playground websocket status'; responses: { 200: { description: "Websocket connection status" = 'Websocket connection status'; content: { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } } } } } } |
paths./api/v1/remote/health | { get: { tags: readonly ["Remote"] ; summary: "Remote server health" = 'Remote server health'; responses: { 200: { description: "OK" = 'OK'; content: { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } } } } } |
paths./api/v1/remote/health.get | { tags: readonly ["Remote"] ; summary: "Remote server health" = 'Remote server health'; responses: { 200: { description: "OK" = 'OK'; content: { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } } } } |
paths./api/v1/remote/health.get.tags | readonly ["Remote"] |
paths./api/v1/remote/health.get.summary | "Remote server health" |
paths./api/v1/remote/health.get.responses | { 200: { description: "OK" = 'OK'; content: { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } } } |
paths./api/v1/remote/health.get.responses.200 | { description: "OK" = 'OK'; content: { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } } |
paths./api/v1/remote/health.get.responses.200.description | "OK" |
paths./api/v1/remote/health.get.responses.200.content | { application/json: { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } } |
paths./api/v1/remote/health.get.responses.200.content.application/json | { schema: { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } } |
paths./api/v1/remote/health.get.responses.200.content.application/json.schema | { $ref: "#/components/schemas/HealthResponse" = '#/components/schemas/HealthResponse' } |
paths./api/v1/remote/health.get.responses.200.content.application/json.schema.$ref | "#/components/schemas/HealthResponse" |
paths./api/v1/remote/chat | { post: { tags: readonly ["Remote"] ; summary: "Chat completion proxy" = 'Chat completion proxy'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Chat response" = 'Chat response'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } } ; 400: { description: "Invalid request (missing provider, model, or messages)" = 'Invalid request (missing provider, model, or messages)'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider error" = 'Provider error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } } |
paths./api/v1/remote/chat.post | { tags: readonly ["Remote"] ; summary: "Chat completion proxy" = 'Chat completion proxy'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Chat response" = 'Chat response'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } } ; 400: { description: "Invalid request (missing provider, model, or messages)" = 'Invalid request (missing provider, model, or messages)'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider error" = 'Provider error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } |
paths./api/v1/remote/chat.post.tags | readonly ["Remote"] |
paths./api/v1/remote/chat.post.summary | "Chat completion proxy" |
paths./api/v1/remote/chat.post.requestBody | { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } |
paths./api/v1/remote/chat.post.requestBody.required | true |
paths./api/v1/remote/chat.post.requestBody.content | { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } |
paths./api/v1/remote/chat.post.requestBody.content.application/json | { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } |
paths./api/v1/remote/chat.post.requestBody.content.application/json.schema | { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } |
paths./api/v1/remote/chat.post.requestBody.content.application/json.schema.$ref | "#/components/schemas/ChatRequest" |
paths./api/v1/remote/chat.post.responses | { 200: { description: "Chat response" = 'Chat response'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } } ; 400: { description: "Invalid request (missing provider, model, or messages)" = 'Invalid request (missing provider, model, or messages)'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider error" = 'Provider error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } |
paths./api/v1/remote/chat.post.responses.200 | { description: "Chat response" = 'Chat response'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } } |
paths./api/v1/remote/chat.post.responses.200.description | "Chat response" |
paths./api/v1/remote/chat.post.responses.200.content | { application/json: { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } } |
paths./api/v1/remote/chat.post.responses.200.content.application/json | { schema: { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } } |
paths./api/v1/remote/chat.post.responses.200.content.application/json.schema | { $ref: "#/components/schemas/ChatResponse" = '#/components/schemas/ChatResponse' } |
paths./api/v1/remote/chat.post.responses.200.content.application/json.schema.$ref | "#/components/schemas/ChatResponse" |
paths./api/v1/remote/chat.post.responses.400 | { description: "Invalid request (missing provider, model, or messages)" = 'Invalid request (missing provider, model, or messages)'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } |
paths./api/v1/remote/chat.post.responses.400.description | "Invalid request (missing provider, model, or messages)" |
paths./api/v1/remote/chat.post.responses.400.content | { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } |
paths./api/v1/remote/chat.post.responses.400.content.application/json | { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } |
paths./api/v1/remote/chat.post.responses.400.content.application/json.schema | { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } |
paths./api/v1/remote/chat.post.responses.400.content.application/json.schema.$ref | "#/components/schemas/ChatErrorResponse" |
paths./api/v1/remote/chat.post.responses.500 | { description: "Provider error" = 'Provider error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } |
paths./api/v1/remote/chat.post.responses.500.description | "Provider error" |
paths./api/v1/remote/chat.post.responses.500.content | { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } |
paths./api/v1/remote/chat.post.responses.500.content.application/json | { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } |
paths./api/v1/remote/chat.post.responses.500.content.application/json.schema | { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } |
paths./api/v1/remote/chat.post.responses.500.content.application/json.schema.$ref | "#/components/schemas/ChatErrorResponse" |
paths./api/v1/remote/stream | { post: { tags: readonly ["Remote"] ; summary: "Streaming chat proxy" = 'Streaming chat proxy'; description: "Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`." = 'Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`.'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Streaming response via SSE" = 'Streaming response via SSE'; content: { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } } ; 400: { description: "Invalid request" = 'Invalid request'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider/streaming error" = 'Provider/streaming error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } } |
paths./api/v1/remote/stream.post | { tags: readonly ["Remote"] ; summary: "Streaming chat proxy" = 'Streaming chat proxy'; description: "Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`." = 'Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`.'; requestBody: { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } ; responses: { 200: { description: "Streaming response via SSE" = 'Streaming response via SSE'; content: { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } } ; 400: { description: "Invalid request" = 'Invalid request'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider/streaming error" = 'Provider/streaming error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } } |
paths./api/v1/remote/stream.post.tags | readonly ["Remote"] |
paths./api/v1/remote/stream.post.summary | "Streaming chat proxy" |
paths./api/v1/remote/stream.post.description | "Opens a Server-Sent Events stream for incremental chat responses. Each frame contains a provider message chunk. Stream terminates with `data: [DONE]`." |
paths./api/v1/remote/stream.post.requestBody | { required: true = true; content: { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } } |
paths./api/v1/remote/stream.post.requestBody.required | true |
paths./api/v1/remote/stream.post.requestBody.content | { application/json: { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } } |
paths./api/v1/remote/stream.post.requestBody.content.application/json | { schema: { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } } |
paths./api/v1/remote/stream.post.requestBody.content.application/json.schema | { $ref: "#/components/schemas/ChatRequest" = '#/components/schemas/ChatRequest' } |
paths./api/v1/remote/stream.post.requestBody.content.application/json.schema.$ref | "#/components/schemas/ChatRequest" |
paths./api/v1/remote/stream.post.responses | { 200: { description: "Streaming response via SSE" = 'Streaming response via SSE'; content: { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } } ; 400: { description: "Invalid request" = 'Invalid request'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } ; 500: { description: "Provider/streaming error" = 'Provider/streaming error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } } |
paths./api/v1/remote/stream.post.responses.200 | { description: "Streaming response via SSE" = 'Streaming response via SSE'; content: { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } } |
paths./api/v1/remote/stream.post.responses.200.description | "Streaming response via SSE" |
paths./api/v1/remote/stream.post.responses.200.content | { text/event-stream: { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } } |
paths./api/v1/remote/stream.post.responses.200.content.text/event-stream | { schema: { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } } |
paths./api/v1/remote/stream.post.responses.200.content.text/event-stream.schema | { type: "string" = 'string'; description: "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." = 'Each SSE frame: `data: <JSON chunk>\n\n`, terminated by `data: [DONE]\n\n`.' } |
paths./api/v1/remote/stream.post.responses.200.content.text/event-stream.schema.type | "string" |
paths./api/v1/remote/stream.post.responses.200.content.text/event-stream.schema.description | "Each SSE frame: `data: <JSON chunk>\\n\\n`, terminated by `data: [DONE]\\n\\n`." |
paths./api/v1/remote/stream.post.responses.400 | { description: "Invalid request" = 'Invalid request'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } |
paths./api/v1/remote/stream.post.responses.400.description | "Invalid request" |
paths./api/v1/remote/stream.post.responses.400.content | { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } |
paths./api/v1/remote/stream.post.responses.400.content.application/json | { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } |
paths./api/v1/remote/stream.post.responses.400.content.application/json.schema | { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } |
paths./api/v1/remote/stream.post.responses.400.content.application/json.schema.$ref | "#/components/schemas/ChatErrorResponse" |
paths./api/v1/remote/stream.post.responses.500 | { description: "Provider/streaming error" = 'Provider/streaming error'; content: { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } } |
paths./api/v1/remote/stream.post.responses.500.description | "Provider/streaming error" |
paths./api/v1/remote/stream.post.responses.500.content | { application/json: { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } } |
paths./api/v1/remote/stream.post.responses.500.content.application/json | { schema: { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } } |
paths./api/v1/remote/stream.post.responses.500.content.application/json.schema | { $ref: "#/components/schemas/ChatErrorResponse" = '#/components/schemas/ChatErrorResponse' } |
paths./api/v1/remote/stream.post.responses.500.content.application/json.schema.$ref | "#/components/schemas/ChatErrorResponse" |
paths./api/v1/remote/providers/{provider}/capabilities | { get: { tags: readonly ["Remote"] ; summary: "Provider capability query" = 'Provider capability query'; parameters: readonly [{ name: "provider" = 'provider'; in: "path" = 'path'; required: true = true; schema: { type: "string" = 'string' } ; description: "Provider identifier." = 'Provider identifier.' }] ; responses: { 200: { description: "Capability payload" = 'Capability payload'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } } ; 404: { description: "Provider not found" = 'Provider not found'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } } } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get | { tags: readonly ["Remote"] ; summary: "Provider capability query" = 'Provider capability query'; parameters: readonly [{ name: "provider" = 'provider'; in: "path" = 'path'; required: true = true; schema: { type: "string" = 'string' } ; description: "Provider identifier." = 'Provider identifier.' }] ; responses: { 200: { description: "Capability payload" = 'Capability payload'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } } ; 404: { description: "Provider not found" = 'Provider not found'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.tags | readonly ["Remote"] |
paths./api/v1/remote/providers/{provider}/capabilities.get.summary | "Provider capability query" |
paths./api/v1/remote/providers/{provider}/capabilities.get.parameters | readonly [{ name: "provider" = 'provider'; in: "path" = 'path'; required: true = true; schema: { type: "string" = 'string' } ; description: "Provider identifier." = 'Provider identifier.' }] |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses | { 200: { description: "Capability payload" = 'Capability payload'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } } ; 404: { description: "Provider not found" = 'Provider not found'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200 | { description: "Capability payload" = 'Capability payload'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200.description | "Capability payload" |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200.content | { application/json: { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200.content.application/json | { schema: { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200.content.application/json.schema | { $ref: "#/components/schemas/ProviderCapabilities" = '#/components/schemas/ProviderCapabilities' } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.200.content.application/json.schema.$ref | "#/components/schemas/ProviderCapabilities" |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404 | { description: "Provider not found" = 'Provider not found'; content: { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404.description | "Provider not found" |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404.content | { application/json: { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404.content.application/json | { schema: { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404.content.application/json.schema | { $ref: "#/components/schemas/ProviderNotFoundResponse" = '#/components/schemas/ProviderNotFoundResponse' } |
paths./api/v1/remote/providers/{provider}/capabilities.get.responses.404.content.application/json.schema.$ref | "#/components/schemas/ProviderNotFoundResponse" |
paths./api/v1/remote/ws/status | { get: { tags: readonly ["Remote"] ; summary: "Playground websocket status" = 'Playground websocket status'; responses: { 200: { description: "Websocket connection status" = 'Websocket connection status'; content: { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } } } } } |
paths./api/v1/remote/ws/status.get | { tags: readonly ["Remote"] ; summary: "Playground websocket status" = 'Playground websocket status'; responses: { 200: { description: "Websocket connection status" = 'Websocket connection status'; content: { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } } } } |
paths./api/v1/remote/ws/status.get.tags | readonly ["Remote"] |
paths./api/v1/remote/ws/status.get.summary | "Playground websocket status" |
paths./api/v1/remote/ws/status.get.responses | { 200: { description: "Websocket connection status" = 'Websocket connection status'; content: { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } } } |
paths./api/v1/remote/ws/status.get.responses.200 | { description: "Websocket connection status" = 'Websocket connection status'; content: { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } } |
paths./api/v1/remote/ws/status.get.responses.200.description | "Websocket connection status" |
paths./api/v1/remote/ws/status.get.responses.200.content | { application/json: { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } } |
paths./api/v1/remote/ws/status.get.responses.200.content.application/json | { schema: { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } } |
paths./api/v1/remote/ws/status.get.responses.200.content.application/json.schema | { type: "object" = 'object'; description: "Runtime status of the websocket subsystem." = 'Runtime status of the websocket subsystem.' } |
paths./api/v1/remote/ws/status.get.responses.200.content.application/json.schema.type | "object" |
paths./api/v1/remote/ws/status.get.responses.200.content.application/json.schema.description | "Runtime status of the websocket subsystem." |
Defined in
Functions
registerRemoteServerRoutes
▸ registerRemoteServerRoutes(options): IRemoteServerRuntime
Parameters
| Name | Type |
|---|---|
options | IRegisterRemoteServerRoutesOptions |