> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inputapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Example index and learning paths

> Find APIs, complete scripts, and validation boundaries by integration goal.

Start with the [quickstart](/en/quickstart.md) to verify the address, credentials, and model, then select one complete example. Sources live in the documentation directory's `examples/`; copy environment variables from the relevant guide. Run `npm ci` there for Node examples. See the [Python guide](/en/guides/python.md) for Python setup and the documentation directory’s `README.md` for complete local checks.

| Goal | Guide / runnable entry point | Key acceptance check |
| - | - | - |
| Minimal text | [Python](/en/guides/python.md) / [TypeScript](/en/guides/typescript.md) | Base URL, model, complete output |
| Framework integration | [Vercel AI SDK](/en/guides/ai-sdk.md) | Actual protocol path, SDK retries, completion state |
| Conversation memory | [Multi-turn conversations](/en/guides/conversations.md) | Complete history within one protocol |
| Client tools | [Tool calling](/en/guides/tool-calling.md) / [streaming tools](/en/guides/streaming-tools.md) | Call IDs, arguments, result association, round limits |
| JSON results | [Structured output](/en/guides/structured-output.md) | Schema validation and incomplete outcomes |
| Document retrieval | [RAG](/en/guides/rag.md) | Embeddings, Rerank, source attribution |
| Images and audio | [Vision](/en/guides/vision.md) / [image generation](/en/guides/image-generation.md) / [speech](/en/guides/speech.md) / [transcription](/en/guides/speech-to-text.md) | Model capability, file types, complete downloads |
| Video and async tasks | [Video](/en/guides/video-generation.md) / [tasks](/en/guides/tasks.md) | Existing task IDs, terminal states, polling limits |
| Persistent connections | [Responses WebSocket](/en/guides/responses-websocket.md) / [Realtime](/en/guides/realtime.md) | Handshake, event correlation, audio format, closure |
| Native protocols | [Claude SSE](/en/guides/native-claude-streaming.md) / [Gemini SSE](/en/guides/native-gemini-streaming.md) | Native blocks, signatures, terminal events |
| Operational diagnostics | [Rate limits](/en/guides/rate-limits.md) / [observability](/en/guides/observability.md) | Read-only probes, bounded retries, sanitized logs |

## From examples to production

1. Run documentation validation against local fixtures to check code and page consistency.
2. Use isolated test settings for one minimal target-deployment request, then verify each required extension separately.
3. Test business failures, timeouts, streaming interruption, and duplicate submission handling before setting queue, concurrency, and logging policies.
4. Record target-service results using the [production checklist](/en/guides/production.md). Local passes do not replace real model verification.

Fields are centralized in the [API reference](/en/api-reference/overview.md). Check [coverage](/en/guides/api-coverage.md) before selecting an endpoint. These scripts work independently of Mintlify's runtime; retain the same examples and OpenAPI file when migrating documentation platforms.

[阅读中文](/zh/guides/recipes.md)

[Prompt caching](/en/guides/prompt-caching.md) · [Reasoning models](/en/guides/reasoning-models.md) · [Context management](/en/guides/context-management.md)

## Files, search, and generation parameters

| Task | Guide | Runnable script |
| - | - | - |
| Inline PDF summary | [File inputs](/en/guides/file-inputs.md) | `examples/file-input.mjs` |
| Native web search with URL citations | [Search](/en/guides/web-search.md) | `examples/web-search.mjs` |
| Inspect token log probabilities | [Generation parameters](/en/guides/generation-parameters.md) | `examples/logprobs.mjs` |

Confirm model and native-channel support before running; also see [data controls](/en/guides/data-controls.md).

## Audio/video input and text revisions

| Goal | Guide | Script |
| - | - | - |
| Ask about a recording | [Audio input](/en/guides/audio-input.md) | `examples/audio-input.mjs` |
| Analyze an existing video | [Video understanding](/en/guides/video-understanding.md) | `examples/video-input.mjs` |
| Hint at retained source during revisions | [Predicted outputs](/en/guides/predicted-outputs.md) | `examples/predicted-output.mjs` |

Each example makes one request. Verify real results with the target model; see [troubleshooting](/en/guides/troubleshooting.md).

## Tool policies and JSON validation

* [Tool selection and parallel controls](/en/guides/tool-controls.md): `examples/tool-policy.mjs`, four policies, at most two turns and one read-only call.
* [JSON mode](/en/guides/json-mode.md): `examples/json-mode.mjs`, Chat / Responses protocols with separate completion and business-field validation.

## Native Gemini built-in tools

[Three-mode example](/en/guides/gemini-builtins.md): `examples/gemini-builtins.mjs` selects search, URL context, or upstream code execution. One request per run; checks task evidence as well as completion.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.