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
4 changes: 4 additions & 0 deletions .github/workflows/docs-validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ on:
paths:
- 'docs/**/*.md'
- 'docs/bin/**'
- 'docs/_config.yml'
- 'docs/_redirects'
- 'docs/package.json'
- 'docs/package-lock.json'
- '.github/workflows/docs-validate.yml'
Expand All @@ -24,6 +26,8 @@ on:
paths:
- 'docs/**/*.md'
- 'docs/bin/**'
- 'docs/_config.yml'
- 'docs/_redirects'
- 'docs/package.json'
- 'docs/package-lock.json'
- '.github/workflows/docs-validate.yml'
Expand Down
6 changes: 3 additions & 3 deletions docs/.well-known/agent-skills/fliplet-js-api/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ The Fliplet client-side JavaScript API: every Fliplet.X namespace (Storage, User
- [Fliplet.AI](https://developers.fliplet.com/API/core/ai.md): Generate text and images, transcribe audio and create embeddings with Fliplet.AI. Covers request formats, streaming, models and limits.
- [Record or upload audio for transcription](https://developers.fliplet.com/API/core/ai/audio-transcription.md): Upload or record audio with Fliplet.AI, retain audio for retry and let users review a transcript before inserting it into their text.
- [Build an AI chatbot](https://developers.fliplet.com/API/core/ai/chatbot.md): Present interactive AI text in conversations, research, writing tools and explanation panels with safe formatting, progressive output and recoverable errors.
- [Answer questions with web sources](https://developers.fliplet.com/API/core/ai/grounded-answers.md): Use Fliplet AI with hosted web search and display returned citations as safe, clickable links beside the answer.
- [Extract editable fields from PDFs and images](https://developers.fliplet.com/API/core/ai/media-inputs.md): Analyze a selected PDF or image with Fliplet AI, validate structured results and let the user review extracted fields before saving.
- [File and image analysis](https://developers.fliplet.com/API/core/ai/file-and-image-analysis.md): Analyze authorized files and images with Fliplet AI. Match input formats and output to the task, with a complete PDF and image extraction example.
- [AI models available through Fliplet](https://developers.fliplet.com/API/core/ai/models.md): Choose compatible AI model IDs, compare verified provider facts and understand Fliplet fallbacks, pinning and retirement notices.
- [Use AI tools with authorized app data](https://developers.fliplet.com/API/core/ai/tool-calling.md): Build a bounded AI tool loop with authorized reads, confirmed record updates, validated arguments and provider-compatible conversation history.
- [Use AI tools in an app](https://developers.fliplet.com/API/core/ai/tool-calling.md): Build a bounded AI tool loop with validated arguments, confirmed local actions and provider-compatible conversation history.
- [Web search and citations](https://developers.fliplet.com/API/core/ai/web-search.md): Use Fliplet AI with hosted web search and display returned citations as safe, clickable links beside the answer.
- [Fliplet.Analytics](https://developers.fliplet.com/API/core/analytics.md): Enable, disable, and check analytics tracking, and record custom app events and page views from JavaScript.
- [Fliplet.API.request()](https://developers.fliplet.com/API/core/api.md): Make authenticated HTTP requests to Fliplet APIs with automatic URL construction, caching, offline queueing, and error handling.
- [Fliplet.App](https://developers.fliplet.com/API/core/app.md): Retrieve the current app's public slug, build shareable screen URLs, and access app-level settings from JavaScript.
Expand Down
2 changes: 1 addition & 1 deletion docs/.well-known/agent-skills/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
"tags": [
"js-api"
],
"sha256": "ca8dab0407604f646e7106e5971bc8918284e8351f8fc1ce52c590c70337aacb"
"sha256": "7007a95ec4372a59848fc0d56c103f8bbf5d5cb7a9e4b46d32650532b12f4ec9"
},
{
"name": "fliplet-docs-index",
Expand Down
811 changes: 328 additions & 483 deletions docs/.well-known/llms-full.txt

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/.well-known/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
- [Fliplet.AI](https://developers.fliplet.com/API/core/ai.md): Generate text and images, transcribe audio and create embeddings with Fliplet.AI. Covers request formats, streaming, models and limits.
- [Record or upload audio for transcription](https://developers.fliplet.com/API/core/ai/audio-transcription.md): Upload or record audio with Fliplet.AI, retain audio for retry and let users review a transcript before inserting it into their text.
- [Build an AI chatbot](https://developers.fliplet.com/API/core/ai/chatbot.md): Present interactive AI text in conversations, research, writing tools and explanation panels with safe formatting, progressive output and recoverable errors.
- [Answer questions with web sources](https://developers.fliplet.com/API/core/ai/grounded-answers.md): Use Fliplet AI with hosted web search and display returned citations as safe, clickable links beside the answer.
- [Extract editable fields from PDFs and images](https://developers.fliplet.com/API/core/ai/media-inputs.md): Analyze a selected PDF or image with Fliplet AI, validate structured results and let the user review extracted fields before saving.
- [File and image analysis](https://developers.fliplet.com/API/core/ai/file-and-image-analysis.md): Analyze authorized files and images with Fliplet AI. Match input formats and output to the task, with a complete PDF and image extraction example.
- [AI models available through Fliplet](https://developers.fliplet.com/API/core/ai/models.md): Choose compatible AI model IDs, compare verified provider facts and understand Fliplet fallbacks, pinning and retirement notices.
- [Use AI tools with authorized app data](https://developers.fliplet.com/API/core/ai/tool-calling.md): Build a bounded AI tool loop with authorized reads, confirmed record updates, validated arguments and provider-compatible conversation history.
- [Use AI tools in an app](https://developers.fliplet.com/API/core/ai/tool-calling.md): Build a bounded AI tool loop with validated arguments, confirmed local actions and provider-compatible conversation history.
- [Web search and citations](https://developers.fliplet.com/API/core/ai/web-search.md): Use Fliplet AI with hosted web search and display returned citations as safe, clickable links beside the answer.
- [Fliplet.Analytics](https://developers.fliplet.com/API/core/analytics.md): Enable, disable, and check analytics tracking, and record custom app events and page views from JavaScript.
- [Fliplet.API.request()](https://developers.fliplet.com/API/core/api.md): Make authenticated HTTP requests to Fliplet APIs with automatic URL construction, caching, offline queueing, and error handling.
- [App Actions V2 (deprecated)](https://developers.fliplet.com/API/core/app-actions-v2.md): Deprecated App Actions V2 — configure a pipeline of functions that runs on-device or in the cloud, ad hoc or on a schedule. Migrate to V3 App Actions.
Expand Down
2 changes: 1 addition & 1 deletion docs/API-Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Index of Fliplet's JavaScript APIs (Core, Data Sources, Media, UI, Communicate)

These JS APIs falls into the most common category and almost all apps, components and themes use at least one of them. All apps include `fliplet-core` by default, and any other can easily be included on your app screens via Fliplet Studio.

- [AI](API/core/ai) (preloaded in `fliplet-core`): text, images, audio, tools, cited research and document/photo analysis
- [AI](API/core/ai) (preloaded in `fliplet-core`): text, images, audio, tools, cited research and file and image analysis
- [Audio](API/fliplet-audio) (`fliplet-audio`)
- [Audio Player](API/fliplet-audio-player) (`fliplet-audio-player`)
- [Barcode](API/fliplet-barcode) (`fliplet-barcode`)
Expand Down
15 changes: 8 additions & 7 deletions docs/API/core/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Generate text and images, transcribe audio and create embeddings through Fliplet
| --- | --- | --- |
| Generated text, summaries or an AI chatbot | [createCompletion()](#flipletaicreatecompletion); [ask()](#instance-methods) for a single text request | [OpenAI text](/API/core/ai/models#openai-text-models) or [Gemini text](/API/core/ai/models#gemini-text-models) |
| Model-requested app operations | [createCompletion()](#flipletaicreatecompletion) and the [tool-calling guide](/API/core/ai/tool-calling) | Compatible function-tool model |
| Research with cited web sources | [createCompletion()](#flipletaicreatecompletion) and the [grounded-answers guide](/API/core/ai/grounded-answers) | Compatible hosted-search model |
| PDF/photo analysis and structured extraction | [createCompletion()](#flipletaicreatecompletion) and the [media-input guide](/API/core/ai/media-inputs) | Compatible file/image and structured-output model |
| Research with cited web sources | [createCompletion()](#flipletaicreatecompletion) and the [web-search guide](/API/core/ai/web-search) | Compatible hosted-search model |
| File and image analysis | [createCompletion()](#flipletaicreatecompletion) and the [file and image analysis guide](/API/core/ai/file-and-image-analysis) | Compatible file/image model; structured-output support when required |
| OpenAI image generation | [generateImage()](#flipletaigenerateimage) | [Images](/API/core/ai/models#image-models) |
| Gemini image generation | [createCompletion() with Gemini contents](#gemini-image-generation) | [Images](/API/core/ai/models#image-models) |
| Audio transcription | [transcribeAudio()](#flipletaitranscribeaudio) | [Transcription](/API/core/ai/models#transcription-models) |
Expand Down Expand Up @@ -171,12 +171,13 @@ Send the payload required by the selected model in the first argument. The optio
| stream | Boolean | `true` chooses streaming; omit or use `false` for a buffered response. |
| prompt | String or Array of Strings | Legacy non-streaming OpenAI completion format. Its [REST fallback is retired](#fallback-defaults); use messages or Responses for new work. |

Streaming has a fixed five-minute internal deadline covering readiness, request start and streaming. Incoming chunks do not extend it.

Client controls apply only when `payload.stream === true`. Omit the second argument or pass `{}` for buffered calls; nonempty buffered controls and invalid controls reject with `TypeError`.

| Client control | Type | Default and behavior |
| --- | --- | --- |
| returnResult | Boolean | `false`. Set `true` to retain the terminal result, including the native Responses object. |
| timeout | Number | `300000` milliseconds. Must be finite and positive. The deadline covers readiness, request start and streaming; incoming chunks do not extend it. |

Use one input format per request. A truthy `prompt` selects the legacy route on a non-streaming call, even if other input fields are also present.

Expand Down Expand Up @@ -217,7 +218,7 @@ async function summarizeWithResponses() {
summarizeWithResponses();
```

For app-managed conversation context, `input` can also be an array such as `[{ role: 'user', content: 'Hello' }, { role: 'assistant', content: 'Hello! How can I help?' }, { role: 'user', content: 'Suggest a meeting agenda.' }]`. Preserve model-required tool items when using tools. Use the [tool-calling](/API/core/ai/tool-calling), [grounded-answer](/API/core/ai/grounded-answers) and [media-input](/API/core/ai/media-inputs) guides for complete workflows. Declaring tools does not execute app operations. Background execution and provider-stored conversations are not established app workflows. See the [Responses schema](https://platform.openai.com/docs/api-reference/responses/create) and [chatbot guide](/API/core/ai/chatbot).
For app-managed conversation context, `input` can also be an array such as `[{ role: 'user', content: 'Hello' }, { role: 'assistant', content: 'Hello! How can I help?' }, { role: 'user', content: 'Suggest a meeting agenda.' }]`. Preserve model-required tool items when using tools. Use the [tool-calling](/API/core/ai/tool-calling), [web-search](/API/core/ai/web-search) and [file and image analysis](/API/core/ai/file-and-image-analysis) guides for complete workflows. Declaring tools does not execute app operations. Background execution and provider-stored conversations are not established app workflows. See the [Responses schema](https://platform.openai.com/docs/api-reference/responses/create) and [chatbot guide](/API/core/ai/chatbot).

#### Using Gemini models

Expand Down Expand Up @@ -297,7 +298,7 @@ async function streamResponseResult(prompt, onText) {
const request = Fliplet.AI.createCompletion({
model: 'gpt-6.1-sol', useResponses: true,
input: prompt, stream: true
}, { returnResult: true, timeout: 300000 });
}, { returnResult: true });
request.stream(function(chunk) {
if (chunk && chunk.type === 'response.output_text.delta' && typeof chunk.delta === 'string') {
onText(chunk.delta);
Expand Down Expand Up @@ -647,7 +648,7 @@ See [JavaScript metadata and additional provider IDs](/API/core/ai/models#histor
- [AI models available through Fliplet](/API/core/ai/models): configured IDs, provider facts, fallback defaults and retirement notices.
- [AI reply presentation and conversations](/API/core/ai/chatbot): safe formatting, progressive output, conversation state and send/retry controls.
- [Tools and authorized actions](/API/core/ai/tool-calling): bounded tool loops, validation and existing app permissions.
- [Research with cited sources](/API/core/ai/grounded-answers): hosted search and safe inline citations.
- [Analyze documents and photos](/API/core/ai/media-inputs): authorized content and validated structured results.
- [Web search and citations](/API/core/ai/web-search): hosted search and safe inline citations.
- [File and image analysis](/API/core/ai/file-and-image-analysis): authorized content, task-appropriate output and validated extraction.
- [Record or upload audio](/API/core/ai/audio-transcription): file selection, microphone capture and transcript insertion.
- [App AI REST API](/REST-API/fliplet-ai): external requests and authentication.
4 changes: 2 additions & 2 deletions docs/API/core/ai/audio-transcription.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,5 +341,5 @@ For permission, credits, MIME and size errors, consult the [method error referen
- [Build an AI chatbot](/API/core/ai/chatbot)
- [App AI REST API](/REST-API/fliplet-ai)
- [Tools and authorized actions](/API/core/ai/tool-calling)
- [Research with cited sources](/API/core/ai/grounded-answers)
- [Analyze documents and photos](/API/core/ai/media-inputs)
- [Web search and citations](/API/core/ai/web-search)
- [File and image analysis](/API/core/ai/file-and-image-analysis)
6 changes: 3 additions & 3 deletions docs/API/core/ai/chatbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ Add persistence only if the feature needs it. [App storage](/API/core/storage) c

For shared or private server storage, use [Data Sources](/API/fliplet-datasources) with [access rules](/Data-source-security) that enforce the intended owner and operations. Establish identity through the app's genuine login flow and designated login data source; writable `Fliplet.Session.set()` fields do not establish authenticated ownership. If the app supports multiple logins, bind the rule to the intended login source and verify which account is active. Do not add a login or conversation data source to a chatbot that only needs temporary public conversation state.

For model-requested operations, use the [tool-calling guide](/API/core/ai/tool-calling). For hosted search and sources use [grounded answers](/API/core/ai/grounded-answers); for PDF/photo input use [media analysis](/API/core/ai/media-inputs). These capabilities are optional and should follow the feature requirements.
For model-requested operations, use the [tool-calling guide](/API/core/ai/tool-calling). For hosted search and sources use [web search and citations](/API/core/ai/web-search); for file and image input use [file and image analysis](/API/core/ai/file-and-image-analysis). These capabilities are optional and should follow the feature requirements.

The model does not automatically read app records. Query only records the current user is authorized to read, then include the smallest relevant context in the request. Treat record text as data, avoid sending unnecessary private fields and check authorization again when performing actions based on a reply. Uploading or storing private attachments also needs the [media API](/API/fliplet-media) and its permissions; data-source login bindings are not media access rules.

Expand All @@ -348,5 +348,5 @@ For access, credits and rate-limit errors, use the [error reference](/API/core/a
- [Record or upload audio](/API/core/ai/audio-transcription)
- [App AI REST API](/REST-API/fliplet-ai)
- [Tools and authorized actions](/API/core/ai/tool-calling)
- [Research with cited sources](/API/core/ai/grounded-answers)
- [Analyze documents and photos](/API/core/ai/media-inputs)
- [Web search and citations](/API/core/ai/web-search)
- [File and image analysis](/API/core/ai/file-and-image-analysis)
Loading
Loading