@proveanything/smartlinks 2.0.10 → 2.0.12

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 2.0.10  |  Generated: 2026-09-21T16:50:28.412Z
+Version: 2.0.12  |  Generated: 2026-09-21T22:28:25.241Z
 
 This is a concise summary of all available API functions and types.
 
@@ -580,6 +580,11 @@ interface ResponsesRequest {
   max_concurrent_subagents?: number
   }
   service_tier?: 'auto' | 'standard' | 'flex' | 'priority'
+  server_tools?: boolean | AiToolName[]
+  allowCapabilities?: AiToolCapability[]
+  only?: AiToolName[]
+  exclude?: AiToolName[]
+  maxSteps?: number
 }
 ```
 
@@ -604,6 +609,7 @@ interface ResponsesResult {
   conversation?: unknown
   provider: 'openai'
   responseTime: number
+  _agent?: ResponsesAgentTrace
 }
 ```
 
@@ -1010,14 +1016,98 @@ interface AISearchPhotosRequest {
 **AISearchPhotosPhoto** (interface)
 ```typescript
 interface AISearchPhotosPhoto {
+  id?: string
   url: string
+  thumb?: string
   alt?: string
+  width?: number
+  height?: number
   photographer?: string
   photographerUrl?: string
   [key: string]: any
 }
 ```
 
+**AISearchPhotosResponse** (interface)
+```typescript
+interface AISearchPhotosResponse {
+  provider: string
+  results: AISearchPhotosPhoto[]
+  total?: number
+  total_pages?: number
+  [key: string]: any
+}
+```
+
+**AIGeneratedImage** (interface)
+```typescript
+interface AIGeneratedImage {
+  url: string | null
+  b64_json: string | null
+  revised_prompt?: string
+  [key: string]: any
+}
+```
+
+**AIGenerateImageResponse** (interface)
+```typescript
+interface AIGenerateImageResponse {
+  provider: string
+  model?: string
+  images: AIGeneratedImage[]
+  [key: string]: any
+}
+```
+
+**AIGenerateContentCandidate** (interface)
+```typescript
+interface AIGenerateContentCandidate {
+  content?: { parts?: Array<{ text?: string; [k: string]: any }>; role?: string; [k: string]: any }
+  finishReason?: string
+  [key: string]: any
+}
+```
+
+**AIGenerateContentResponse** (interface)
+```typescript
+interface AIGenerateContentResponse {
+  provider?: string
+  model?: string
+  candidates?: AIGenerateContentCandidate[]
+  usageMetadata?: {
+  promptTokenCount?: number
+  candidatesTokenCount?: number
+  totalTokenCount?: number
+  [k: string]: any
+  }
+  responseTime?: number
+  [key: string]: any
+}
+```
+
+**AIUploadedFile** (interface)
+```typescript
+interface AIUploadedFile {
+  name?: string
+  uri?: string
+  url?: string
+  mimeType?: string
+  sizeBytes?: number | string
+  state?: string
+  [key: string]: any
+}
+```
+
+**AICacheRef** (interface)
+```typescript
+interface AICacheRef {
+  name?: string
+  model?: string
+  expireTime?: string
+  [key: string]: any
+}
+```
+
 **AgentRunRequest** (interface)
 ```typescript
 interface AgentRunRequest {
@@ -1104,6 +1194,258 @@ interface CatalogResponse {
 }
 ```
 
+**WebFetchPageArgs** (interface)
+```typescript
+interface WebFetchPageArgs {
+  url: string; type?: string; forceRefresh?: boolean
+}
+```
+
+**WebExtractSchemaArgs** (interface)
+```typescript
+interface WebExtractSchemaArgs {
+  url: string; schemaType?: string; forceRefresh?: boolean
+}
+```
+
+**WebScreenshotArgs** (interface)
+```typescript
+interface WebScreenshotArgs {
+  url: string
+}
+```
+
+**WebSearchArgs** (interface)
+```typescript
+interface WebSearchArgs {
+  query: string; limit?: number; scrapeContent?: boolean
+}
+```
+
+**BrandAssetsArgs** (interface)
+```typescript
+interface BrandAssetsArgs {
+  url: string
+}
+```
+
+**DocumentReadArgs** (interface)
+```typescript
+interface DocumentReadArgs {
+  url: string; forceRefresh?: boolean
+}
+```
+
+**DataExtractArgs** (interface)
+```typescript
+interface DataExtractArgs {
+  url: string; schema?: Record<string, any>; prompt?: string
+}
+```
+
+**ImageDescribeArgs** (interface)
+```typescript
+interface ImageDescribeArgs {
+  imageUrl: string; prompt?: string
+}
+```
+
+**ImageGenerateArgs** (interface)
+```typescript
+interface ImageGenerateArgs {
+  prompt: string; size?: string; provider?: 'openai' | 'gemini'
+}
+```
+
+**ImageFromReferenceArgs** (interface)
+```typescript
+interface ImageFromReferenceArgs {
+  prompt: string; imageUrls: string[]; size?: string; model?: string
+}
+```
+
+**ImageSearchStockArgs** (interface)
+```typescript
+interface ImageSearchStockArgs {
+  query: string; per_page?: number; orientation?: 'landscape' | 'portrait' | 'squarish'
+}
+```
+
+**ImageTransformArgs** (interface)
+```typescript
+interface ImageTransformArgs {
+  imageUrl: string
+  resize?: { width?: number; height?: number; fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside'; allowUpscale?: boolean }
+  crop?: { left: number; top: number; width: number; height: number }
+  rotate?: number
+  flip?: boolean
+  flop?: boolean
+  grayscale?: boolean
+  tint?: string
+  modulate?: { brightness?: number; saturation?: number; hue?: number; lightness?: number }
+  format?: 'jpeg' | 'png' | 'webp' | 'avif'
+  quality?: number
+}
+```
+
+**PdfCreateArgs** (interface)
+```typescript
+interface PdfCreateArgs {
+  html: string; format?: string; landscape?: boolean
+}
+```
+
+**PdfFillArgs** (interface)
+```typescript
+interface PdfFillArgs {
+  url: string; fields: Record<string, string | number | boolean>; flatten?: boolean
+}
+```
+
+**PdfMergeArgs** (interface)
+```typescript
+interface PdfMergeArgs {
+  urls: string[]
+}
+```
+
+**HttpRequestArgs** (interface)
+```typescript
+interface HttpRequestArgs {
+  url: string; method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD'; headers?: Record<string, string>; body?: any
+}
+```
+
+**TranslateArgs** (interface)
+```typescript
+interface TranslateArgs {
+  text: string; targetLanguages: string[]; sourceLanguage?: string
+}
+```
+
+**AiToolArgsMap** (interface)
+```typescript
+interface AiToolArgsMap {
+  'web.fetchPage': WebFetchPageArgs
+  'web.extractSchema': WebExtractSchemaArgs
+  'web.screenshot': WebScreenshotArgs
+  'web.search': WebSearchArgs
+  'brand.assets': BrandAssetsArgs
+  'document.read': DocumentReadArgs
+  'data.extract': DataExtractArgs
+  'image.describe': ImageDescribeArgs
+  'image.generate': ImageGenerateArgs
+  'image.fromReference': ImageFromReferenceArgs
+  'image.searchStock': ImageSearchStockArgs
+  'image.transform': ImageTransformArgs
+  'pdf.create': PdfCreateArgs
+  'pdf.fill': PdfFillArgs
+  'pdf.merge': PdfMergeArgs
+  'http.request': HttpRequestArgs
+  'translate': TranslateArgs
+}
+```
+
+**WebSearchResultItem** (interface)
+```typescript
+interface WebSearchResultItem {
+  url: string | null; title: string | null; description: string | null; markdown?: string
+}
+```
+
+**WebSearchResult** (interface)
+```typescript
+interface WebSearchResult {
+  query: string; results: WebSearchResultItem[]
+}
+```
+
+**DocumentReadResult** (interface)
+```typescript
+interface DocumentReadResult {
+  url: string; text: string | null; metadata?: any; provider?: string; cached?: boolean
+}
+```
+
+**DataExtractResult** (interface)
+```typescript
+interface DataExtractResult {
+  url: string; data: Record<string, any>
+}
+```
+
+**WebFetchPageResult** (interface)
+```typescript
+interface WebFetchPageResult {
+  url: string; markdown?: string | null; html?: string | null; metadata?: any; schemas?: any[]; provider?: string; cached?: boolean; status?: number | null
+}
+```
+
+**ImageDescribeResult** (interface)
+```typescript
+interface ImageDescribeResult {
+  imageUrl: string; text: string | null
+}
+```
+
+**HostedAssetResult** (interface)
+```typescript
+interface HostedAssetResult {
+  hostedUrl: string | null; contentType?: string; info?: { width?: number; height?: number; format?: string; size?: number }
+}
+```
+
+**HttpRequestResult** (interface)
+```typescript
+interface HttpRequestResult {
+  status: number; headers: Record<string, any>; body: any; truncated: boolean; finalUrl: string
+}
+```
+
+**TranslateResult** (interface)
+```typescript
+interface TranslateResult {
+  translations: Record<string, string>; sourceLanguage: string
+}
+```
+
+**ResponsesAgentTrace** (interface)
+```typescript
+interface ResponsesAgentTrace {
+  steps: number
+  maxStepsReached: boolean
+  toolResults: AgentToolResult[]
+  availableTools: string[]
+}
+```
+
+**AgentToolCallEvent** (interface)
+```typescript
+interface AgentToolCallEvent {
+  type: 'agent.tool_call'; name: string; args: Record<string, any>
+}
+```
+
+**AgentToolResultEvent** (interface)
+```typescript
+interface AgentToolResultEvent {
+  type: 'agent.tool_result'; name: string; isError: boolean; result: any
+}
+```
+
+**AgentResponseCompletedEvent** (interface)
+```typescript
+interface AgentResponseCompletedEvent {
+  type: 'response.completed'; response: ResponsesResult; _agent: ResponsesAgentTrace
+}
+```
+
+**AiToolCapability** = ``
+
+**AiToolName** = ``
+
+**AgentStreamEvent** = ``
+
 ### analytics
 
 **AnalyticsLocation** (interface)

package/docs/ai.md

@@ -257,6 +257,85 @@ const response = await ai.chat.responses.create('my-collection', {
 console.log(response.output);
 ```
 
+### Server-side tools (built-in agent loop)
+
+The example above is **client-relayed** tool calling: you define the tools, the model returns
+`tool_call` requests, and *your app* executes them and sends results back. For the common tools —
+reading and searching the web, vision, reading documents, generating images — the platform ships a
+curated, tested **built-in toolset it runs itself**. Opt in with `server_tools` and the server
+executes each tool and feeds the result back automatically, looping until the model has its answer.
+You get one final response; no relay code.
+
+```typescript
+// Enable the whole built-in toolset:
+const res = await ai.chat.responses.create('my-collection', {
+  model: 'balanced',
+  input: 'Research acme.com and summarise what they sell, with their brand colours.',
+  server_tools: true
+});
+console.log(res.output_text);
+console.log(res._agent.toolResults); // trace: which tools ran, with what result
+```
+
+Scope it to specific tools (recommended — smaller blast radius, faster), by name or capability:
+
+```typescript
+import { AI_TOOL_NAMES } from '@proveanything/smartlinks';
+
+const res = await ai.chat.responses.create('my-collection', {
+  input: 'Find the current price of this product and return it as JSON.',
+  server_tools: [AI_TOOL_NAMES.WEB_SEARCH, AI_TOOL_NAMES.DATA_EXTRACT],
+  // or: allowCapabilities: ['web:read'],   exclude: ['image.generate'],
+  maxSteps: 6 // cap model round-trips (1–12, default 8)
+});
+```
+
+**Streaming** surfaces tool progress as it happens — ideal for a "thinking…" UI. You get
+`agent.tool_call` / `agent.tool_result` events, then a final `response.completed`:
+
+```typescript
+const stream = await ai.chat.responses.create('my-collection', {
+  input: 'Research acme.com', server_tools: true, stream: true
+});
+for await (const ev of stream) {
+  if (ev.type === 'agent.tool_call')   showStep(`Running ${ev.name}…`);
+  if (ev.type === 'agent.tool_result') showStep(`${ev.name} done`);
+  if (ev.type === 'response.completed') render(ev.response.output_text);
+}
+```
+
+`server_tools` can't be combined with `previous_response_id`/`conversation` yet — pass prior turns
+in `input`.
+
+#### Built-in tools
+
+| Tool | Does |
+|------|------|
+| `web.search` | Live web search → candidate results (url/title/description). |
+| `web.fetchPage` | Fetch a page → clean markdown + metadata + schema.org JSON-LD. |
+| `web.extractSchema` | Return only a page's schema.org data of a given `@type` (deterministic). |
+| `document.read` | Read a document at a URL — **PDF, deck, doc**, or article — into markdown. |
+| `data.extract` | Page + JSON-schema/prompt → **typed JSON** (turn a page into UI data). |
+| `brand.assets` | Extract a site's logo, colours, and design. |
+| `web.screenshot` | Screenshot a page → hosted image URL (feed to `image.describe`). |
+| `image.describe` | Vision: describe an image / read its text. |
+| `image.generate` | Generate an image from a prompt → hosted URL. |
+| `image.fromReference` | Image-to-image: generate guided by reference image(s). |
+| `image.searchStock` | Search real stock photos (Unsplash). |
+| `image.transform` | Resize / crop / rotate / grayscale / format-convert / compress → hosted URL. |
+| `pdf.create` | Render HTML → PDF → hosted URL. |
+| `pdf.fill` | Fill an AcroForm PDF's fields → hosted URL. |
+| `pdf.merge` | Merge several PDFs into one → hosted URL. |
+| `http.request` | SSRF-guarded outbound HTTP(S) to a public URL (call a REST API). |
+| `translate` | Translate text into one or more languages (generic, model-based). |
+
+Discover tools two ways:
+- **Design time (typed):** import `BUILTIN_AI_TOOLS`, `AI_TOOL_NAMES`, and the per-tool arg types
+  (`WebSearchArgs`, `DataExtractArgs`, …) from the SDK. This is the core set — stable, versioned,
+  documented here.
+- **Runtime (live):** `await ai.catalog(collectionId)` returns the registry as the server sees it,
+  including any future app-contributed tools. The built-in set above is always present.
+
 ### Recommended Models
 
 For agentic workflows on `v1/responses`, GPT-5.6 ships in three tiers. Pass either the full model