Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ To chat with other community members you can join the [Agentuity Discord server]

The structure of this mono repository:

- `packages/aigateway` - AI Gateway service client for model discovery and LLM completions
- `packages/auth` - Agentuity unified Authentication package
- `packages/claude-code` - Claude Code plugin with multi-agent coding team
- `packages/cli` - the Agentuity command line tool
Expand Down
23 changes: 21 additions & 2 deletions apps/docs/scripts/generate-api-reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
Service,
} from '../../../packages/core/src/services/api-reference.ts';
import { resolveFields } from '../../../packages/core/src/services/api-reference.ts';
import aiGatewayService from '../../../packages/core/src/services/aigateway/api-reference.ts';
import apiKeysService from '../../../packages/core/src/services/apikey/api-reference.ts';
import coderService from '../../../packages/core/src/services/coder/api-reference.ts';
import databaseService from '../../../packages/core/src/services/db/api-reference.ts';
Expand All @@ -32,6 +33,7 @@ import vectorService from '../../../packages/core/src/services/vector/api-refere
import webhooksService from '../../../packages/core/src/services/webhook/api-reference.ts';

const services: Service[] = [
aiGatewayService,
apiKeysService,
coderService,
databaseService,
Expand Down Expand Up @@ -105,6 +107,16 @@ function renderResponseHeaders(headers: ResponseHeader[], subHeading: string): s
].join('\n');
}

function renderAuthentication(service: Service): string {
if (service.hasPublicEndpoints) {
if (service.slug !== 'ai-gateway') {
return 'Most requests require a Bearer token. Pass your API or SDK key in the `Authorization` header. Public endpoints (such as listing and fetching public snapshots) are noted below and do not require authentication.';
}
return 'Most requests require a Bearer token. Pass your API or SDK key in the `Authorization` header. Public endpoints are noted below and do not require authentication.';
}
return 'All requests require a Bearer token. Pass your API or SDK key in the `Authorization` header.';
}

function renderEndpointSection(endpoint: Endpoint, headingLevel = 2, host?: string): string {
const subHeading = '#'.repeat(headingLevel + 1);
const pathParams = toParamTableInput(endpoint.pathParams, 'path');
Expand Down Expand Up @@ -180,6 +192,7 @@ function renderEndpointSection(endpoint: Endpoint, headingLevel = 2, host?: stri
'',
`<ApiEndpoint method="${endpoint.method}" path="${endpoint.path}"${hostProp} />`,
'',
...(endpoint.public ? ['**Authentication:** Public. No auth required.', ''] : []),
paramSection,
requestBodyParts.join('\n'),
responseParts.join('\n'),
Expand Down Expand Up @@ -222,7 +235,7 @@ description: ${service.description}

## Authentication

${service.hasPublicEndpoints ? 'Most requests require a Bearer token. Pass your API or SDK key in the `Authorization` header. Public endpoints (such as listing and fetching public snapshots) are noted below and do not require authentication.' : 'All requests require a Bearer token. Pass your API or SDK key in the `Authorization` header.'}
${renderAuthentication(service)}

| Header | Value |
|--------|-------|
Expand All @@ -243,11 +256,17 @@ description: Direct HTTP access to Agentuity platform services

{/* This file is auto-generated from Zod schemas. Do not edit manually. Run scripts/generate-api-reference.ts to regenerate. */}

import { Activity, Box, BrainCircuit, Building, Clock, Database, FolderKanban, Globe, HardDrive, Key, Layers, ListTodo, Mail, MessageSquare, Search, Server, Shield, Table, Timer, User, Webhook } from 'lucide-react';
import { Activity, Box, BrainCircuit, Building, Clock, Cpu, Database, FolderKanban, Globe, HardDrive, Key, Layers, ListTodo, Mail, MessageSquare, Search, Server, Shield, Table, Timer, User, Webhook } from 'lucide-react';

Access any Agentuity Platform Service directly via REST APIs, the TypeScript SDK or the CLI.

<Cards>
<CardLink
href="/reference/api/ai-gateway"
title="AI Gateway"
description="List supported LLM models and run OpenAI-compatible chat completions"
icon={<Cpu className="size-5" />}
/>
<CardLink
href="/reference/api/api-keys"
title="API Keys"
Expand Down
6 changes: 6 additions & 0 deletions apps/docs/src/web/components/docs/nav-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -658,6 +658,12 @@ export const navData: NavSection[] = [
title: 'API Reference',
url: '/reference/api',
items: [
{
title: 'AI Gateway',
url: '/reference/api/ai-gateway',
description:
'List supported LLM models and run OpenAI-compatible chat completions',
},
{
title: 'API Keys',
url: '/reference/api/api-keys',
Expand Down
Loading
Loading