Skip to content

fix(console): the API console's AI group lists the routes that exist (framework#3718) #2921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jul 28, 2026
Merged

fix(console): the API console's AI group lists the routes that exist (framework#3718) #2921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions apps/console/src/pages/developer/hooks/useApiDiscovery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,35 @@ function buildAuthEndpoints(authBase: string): EndpointDef[] {
}

export const SERVICE_ENDPOINT_CATALOG: Record<string, { group: string; defaultRoute: string; endpoints: ServiceEndpointEntry[] }> = {
// The twelve routes `buildAIRoutes()` mounts, in table order (framework#3718).
// `/nlq`, `/suggest` and `/insights` used to sit here with "try it" bodies and
// always 404'd — they were declared in the framework's `DEFAULT_AI_ROUTES` and
// never implemented anywhere, so this page offered three endpoints that had no
// server. The audited table is cloud's `packages/service-ai/src/
// ai-route-ledger.ts`; when a route is added or renamed there, mirror it here.
//
// `/status` and `/effective-model` are deliberately NOT SDK surface (operator
// diagnostics) — which is exactly why they belong on this page: it explores raw
// HTTP, not `client.*`.
ai: {
group: 'AI',
defaultRoute: '/api/v1/ai',
endpoints: [
{ method: 'POST', path: '/chat', desc: 'Chat completion', bodyTemplate: { messages: [{ role: 'user', content: '' }] } },
// The endpoint STREAMS unless told otherwise, so the JSON template says so:
// without `stream: false` a "try it" here buffers an SSE body as text.
// `/chat/stream` below is the one that means to stream.
{ method: 'POST', path: '/chat', desc: 'Chat completion (JSON)', bodyTemplate: { messages: [{ role: 'user', content: '' }], stream: false } },
{ method: 'POST', path: '/chat/stream', desc: 'Streaming chat (SSE)', bodyTemplate: { messages: [{ role: 'user', content: '' }] } },
{ method: 'POST', path: '/complete', desc: 'Text completion', bodyTemplate: { prompt: '' } },
{ method: 'GET', path: '/models', desc: 'List available models' },
{ method: 'POST', path: '/nlq', desc: 'Natural language query', bodyTemplate: { query: '' } },
{ method: 'POST', path: '/suggest', desc: 'AI-powered suggestions', bodyTemplate: { object: '', field: '', context: {} } },
{ method: 'POST', path: '/insights', desc: 'AI-generated insights', bodyTemplate: { object: '', recordIds: [] } },
{ method: 'GET', path: '/status', desc: 'Active LLM adapter provenance' },
{ method: 'GET', path: '/effective-model', desc: 'Effective model ids and where they came from' },
{ method: 'POST', path: '/conversations', desc: 'Create conversation', bodyTemplate: {} },
{ method: 'GET', path: '/conversations', desc: 'List conversations' },
{ method: 'POST', path: '/conversations/:id/messages', desc: 'Add message to conversation', bodyTemplate: { role: 'user', content: '' } },
{ method: 'GET', path: '/conversations/:id', desc: 'Get conversation with message history' },
{ method: 'PATCH', path: '/conversations/:id', desc: 'Update conversation (title, metadata)', bodyTemplate: { title: '' } },
{ method: 'DELETE', path: '/conversations/:id', desc: 'Delete conversation' },
{ method: 'POST', path: '/conversations/:id/messages', desc: 'Add message to conversation', bodyTemplate: { role: 'user', content: '' } },
],
},
workflow: {
Expand Down
Loading