Features REST API Reference | PraisonAIUI Docs

Features REST API ReferenceComplete API reference for all 36 PraisonAIUI feature protocol endpoints.Feature RegistryGET /api/featuresList all registered features with health status.Response:ChannelsGET /api/channelsList all configured channels with live gateway status.POST /api/channelsAdd a channel.GET /api/channels/platformsList supported platforms.GET /api/channels/{id}Get channel details.PUT /api/channels/{id}Update channel configuration. Body fields: name, platform, enabled, config.DELETE /api/channels/{id}Remove a channel.POST /api/channels/{id}/toggleToggle channel enabled/disabled.GET /api/channels/{id}/statusGet live channel status (enriched via gateway).POST /api/channels/{id}/restartRestart a channel bot via the gateway. Returns status of restart attempt.---SchedulesPOST /api/schedulesAdd a scheduled job.GET /api/schedulesList all scheduled jobs.GET /api/schedules/{id}Get job details.PUT /api/schedules/{id}Update schedule configuration. Body fields: name, message, schedule, enabled.DELETE /api/schedules/{id}Remove a job.POST /api/schedules/{id}/toggleToggle job enabled/disabled.POST /api/schedules/{id}/runTrigger job immediately.POST /api/schedules/{id}/stopStop a running scheduled job. Attempts to cancel via AgentScheduler if available.GET /api/schedules/{id}/statsGet execution statistics for a schedule.---JobsPOST /api/jobsSubmit a new async job. Returns 202 Accepted.GET /api/jobsList jobs with optional filters. Query: ?status=running, ?limit=50, ?offset=0GET /api/jobs/statsGet executor statistics.GET /api/jobs/{id}Get full job details.GET /api/jobs/{id}/statusGet job status with progress info.GET /api/jobs/{id}/resultGet job result. Returns 409 if not yet complete.POST /api/jobs/{id}/cancelCancel a running or queued job. Returns 409 if already complete.DELETE /api/jobs/{id}Delete a completed job. Returns 409 if still running.GET /api/jobs/{id}/streamSSE stream for real-time job updates. Events: status, progress, result, error, done.---UsageGET /api/usageUsage summary with totals and averages.POST /api/usage/trackTrack a usage event.GET /api/usage/detailsDetailed usage records. Query: ?limit=100, ?offset=0GET /api/usage/modelsPer-model breakdown (tokens, cost, request count).GET /api/usage/sessionsPer-session breakdown.GET /api/usage/agentsPer-agent breakdown.GET /api/usage/timeseriesTime-series data for charts. Query: ?hours=24, ?bucket_minutes=60GET /api/usage/costsGet the model cost table (per-1K token rates for 21 models).---MemoryPOST /api/memoryAdd a memory entry.POST /api/memory/searchSearch memories.GET /api/memoryList all memories. Query: ?type=short|long|entity|allGET /api/memory/{id}Get single memory.DELETE /api/memory/{id}Delete single memory.DELETE /api/memoryClear memories. Query: ?type=allPOST /api/memory/contextGet memory context for prompt injection.---Extended SessionsGET /api/sessions/{session_id}/stateGet session state.POST /api/sessions/{session_id}/stateSave session state.POST /api/sessions/{session_id}/contextBuild context from session state + memory.POST /api/sessions/{session_id}/compactCompact session data. Returns before/after stats.POST /api/sessions/{session_id}/resetReset session. Body: {"mode": "clear"}GET /api/sessions/{session_id}/previewFormatted session preview without full history.GET/POST /api/sessions/{session_id}/labelsGet or set session labels.GET /api/sessions/{session_id}/usageGet session usage statistics.---SkillsTool catalog with 18 built-in tools across 7 categories (search, crawl, file, code, shell, skills, schedule).GET /api/skillsList all tools. Query: ?category=search, ?enabled=true, ?search=webGET /api/skills/categoriesList tool categories.POST /api/skillsRegister a custom skill.GET /api/skills/{id}Get tool details including required API keys.PUT /api/skills/{id}Update a custom skill.DELETE /api/skills/{id}Remove a custom skill (builtin tools cannot be deleted).POST /api/skills/{id}/toggleToggle tool enabled/disabled.PUT /api/skills/{id}/configSet tool configuration or API keys.---HooksPOST /api/hooksRegister a hook.GET /api/hooksList all hooks.GET /api/hooks/logView hook execution log. Query: ?limit=20GET /api/hooks/{id}Get hook details.POST /api/hooks/{id}/triggerTrigger a hook manually.DELETE /api/hooks/{id}Remove hook.---WorkflowsPOST /api/workflowsCreate a workflow.GET /api/workflowsList all workflows.GET /api/workflows/runsList all workflow runs.GET /api/workflows/runs/{run_id}Get run details.GET /api/workflows/{id}Get workflow details.POST /api/workflows/{id}/runExecute a workflow.GET /api/workflows/{id}/statusGet workflow status (total runs, last run).DELETE /api/workflows/{id}Delete workflow.---Config RuntimeGET /api/config/runtimeGet all runtime config.PATCH /api/config/runtimeMerge config values.PUT /api/config/runtimeReplace entire config.GET /api/config/runtime/historyConfig change history. Query: ?limit=50GET /api/config/runtime/{key}Get single config key.PUT /api/config/runtime/{key}Set single config key.DELETE /api/config/runtime/{key}Delete config key.GET /api/config/schemaJSON Schema for schema-driven form rendering.POST /api/config/validateValidate config without applying.POST /api/config/applyValidate and apply config changes.GET /api/config/defaultsGet default values from schema.---AgentsAgent definition CRUD with model selection, system prompts, and duplication.GET /api/agents/definitionsList all agent definitions.POST /api/agents/definitionsCreate a new agent.GET /api/agents/definitions/{id}Get agent details.PUT /api/agents/definitions/{id}Update agent. Body fields: name, description, model, temperature, system_prompt, instructions, tools, icon.DELETE /api/agents/definitions/{id}Delete agent.GET /api/agents/modelsList available models (13 models across OpenAI, Anthropic, Google).POST /api/agents/run/{id}Execute an agent via praisonaiagents.Agent.start().POST /api/agents/duplicate/{id}Duplicate an existing agent.---OpenAI-Compatible APIDrop-in replacement for OpenAI SDK. Use base_url="http://localhost:8000/v1".GET /v1API info with available endpoint list.POST /v1/chat/completionsChat completions (OpenAI-compatible).POST /v1/completionsLegacy text completions.POST /v1/embeddingsCreate embeddings.POST /v1/images/generationsGenerate images (DALL-E).POST /v1/audio/transcriptionsTranscribe audio (Whisper).POST /v1/audio/speechText to speech.POST /v1/moderationsContent moderation.GET /v1/modelsList available models (13 models).GET /v1/models/{id}Get model info.POST /v1/responsesOpenAI Responses API.GET/POST /v1/filesFile management.GET/DELETE /v1/files/{id}File operations.GET/POST /v1/assistantsAssistants API.---LogsReal-time log streaming via WebSocket.WS /api/logs/streamWebSocket for real-time log streaming. Query: ?level=INFO, ?search=agentGET /api/logs/levelsAvailable log levels with colors.GET /api/logs/statsLog buffer statistics.POST /api/logs/clearClear the log buffer.---AuthMulti-mode authentication (none, api_key, session, password).GET /api/auth/statusCheck current auth status.GET /api/auth/configGet auth configuration.PUT /api/auth/configSet auth configuration. Body: {"mode": "session", "session_timeout_hours": 48}GET /api/auth/keysList API keys.POST /api/auth/keysCreate API key.DELETE /api/auth/keys/{id}Revoke API key.POST /api/auth/loginLogin with password.POST /api/auth/logoutLogout current session.GET /api/auth/sessionsList active sessions.POST /api/auth/passwordSet or change password.---TTS (Text-to-Speech)GET /api/tts/voicesList available voices.POST /api/tts/synthesizeSynthesize speech from text.---MarketplacePlugin discovery, search, install, and management.GET /api/marketplace/pluginsList all available plugins.POST /api/marketplace/searchSearch plugins by query.POST /api/marketplace/installInstall a plugin.POST /api/marketplace/uninstallUninstall a plugin.GET /api/marketplace/plugins/{id}Get plugin details.---Code ExecutionSandboxed code execution with language allowlists.GET /api/code/languagesList supported languages.POST /api/code/executeExecute code in sandbox.---PWAProgressive Web App support — manifest, service worker, and installability.GET /manifest.jsonWeb Application Manifest for installability.GET /sw.jsService Worker JavaScript with cache-first strategy.GET /api/pwa/configPWA configuration details.---i18nInternationalization with locale switching and string lookup.GET /api/i18n/localesList available locales.GET /api/i18n/strings/{locale}Get all strings for a locale.POST /api/i18n/translateTranslate a key with optional variables.GET /api/i18n/localeGet current default locale.POST /api/i18n/localeSet default locale.---Device PairingPair devices to sessions using short hex codes.POST /api/pairing/createGenerate a pairing code.POST /api/pairing/validateValidate and consume a pairing code.GET /api/pairing/devicesList paired devices. Query: ?session_id=my-sessionDELETE /api/pairing/devices/{id}Remove a paired device.---Media AnalysisImage understanding, OCR, and object detection via VisionAgent.GET /api/media/capabilitiesList analysis capabilities.POST /api/media/analyzeAnalyze an image.POST /api/media/ocrExtract text from an image.---GuardrailsInput/output safety guardrails — validation rules, violation tracking, and registration.GET /api/guardrailsList all registered guardrails.GET /api/guardrails/statusGuardrails feature health.GET /api/guardrails/violationsList guardrail violations.POST /api/guardrails/registerRegister a guardrail rule.---EvalAgent evaluation — accuracy scoring, judge models, and evaluation runs.GET /api/evalOverview of evaluation state.GET /api/eval/statusEval feature health.GET /api/eval/scoresGet evaluation scores.GET /api/eval/judgesList configured judge models.POST /api/eval/runRun an evaluation.---TelemetryPerformance monitoring — metrics collection, performance stats, and profiling.GET /api/telemetryTelemetry overview.GET /api/telemetry/statusTelemetry feature health.GET /api/telemetry/metricsGet collected metrics.GET /api/telemetry/performanceGet performance statistics.GET /api/telemetry/profilingGet profiling data.POST /api/telemetry/recordRecord a telemetry event.---TracesDistributed tracing and observability — span recording, trace lookup, and span details.GET /api/tracesList recent traces.GET /api/traces/statusTracing feature health.GET /api/traces/spansList trace spans.POST /api/traces/recordRecord a trace span.GET /api/traces/{trace_id}Get full trace details.---SecuritySecurity monitoring — audit logging, configuration review, and access control.GET /api/securitySecurity overview.GET /api/security/statusSecurity feature health.GET /api/security/auditGet audit log entries.GET /api/security/configGet security configuration.