diff --git a/admin-openapi.json b/admin-openapi.json index c433d51487..6f3c5ca8f8 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -20,7 +20,7 @@ "post": { "summary": "Create agent job (v1)", "deprecated": true, - "description": "Deprecated: use [v2 create agent job](/api/agent/v2/create-agent-job) instead. Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", + "description": "Deprecated: use [Create agent job](/api/agent/create-agent-job) instead. Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", "parameters": [ { "name": "projectId", @@ -117,7 +117,8 @@ "get": { "summary": "Get agent job by ID (v1)", "deprecated": true, - "description": "Deprecated: use [v2 get agent job](/api/agent/v2/get-agent-job) instead. Retrieves the details and status of a specific agent job by its ID.", + "x-hidden": true, + "description": "Deprecated: use [Get agent job](/api/agent/get-agent-job) instead. Retrieves the details and status of a specific agent job by its ID.", "parameters": [ { "name": "projectId", @@ -228,7 +229,8 @@ "get": { "summary": "Get all agent jobs (v1)", "deprecated": true, - "description": "Deprecated: use [v2 get agent job](/api/agent/v2/get-agent-job) instead. Retrieves all agent jobs for the specified domain, including their status and details.", + "x-hidden": true, + "description": "Deprecated: use [Get agent job](/api/agent/get-agent-job) instead. Retrieves all agent jobs for the specified domain, including their status and details.", "parameters": [ { "name": "projectId", diff --git a/api/agent/create-agent-job.mdx b/api/agent/create-agent-job.mdx deleted file mode 100644 index 6d0e1a1419..0000000000 --- a/api/agent/create-agent-job.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Create agent job (v1)" -openapi: /admin-openapi.json POST /v1/agent/{projectId}/job -keywords: [ "agent job", "create", "automation", "automate" ] -tag: "deprecated" - ---- - -This endpoint is deprecated. Use the [v2 create agent job](/api/agent/v2/create-agent-job) endpoint instead. - -This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results. - -If a branch doesn't exist, the agent creates one. If files are edited successfully, a pull request is automatically created at the end of the job. - -## Rate limits - -The agent API has the following limits: - -- 100 uses per Mintlify project per hour - -## Suggested usage - -For best results, use the [useChat hook from ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) to send requests and handle responses. diff --git a/api/agent/get-agent-job.mdx b/api/agent/get-agent-job.mdx deleted file mode 100644 index a1ef4d92af..0000000000 --- a/api/agent/get-agent-job.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Get agent job (v1)" -openapi: /admin-openapi.json GET /v1/agent/{projectId}/job/{id} -keywords: [ "agent job", "status", "retrieve", "details" ] -tag: "deprecated" - ---- - -This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead. - -## Usage - -This endpoint retrieves the details and status of a specific agent job by its unique identifier. Use this to check the progress, status, and results of a previously created agent job. - -## Job details - -The response includes information such as: -- Job execution status and completion state -- Branch information and pull request details -- Session metadata and timestamps diff --git a/api/agent/get-all-jobs.mdx b/api/agent/get-all-jobs.mdx deleted file mode 100644 index ab12075b47..0000000000 --- a/api/agent/get-all-jobs.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "List agent jobs (v1)" -openapi: /admin-openapi.json GET /v1/agent/{projectId}/jobs -keywords: [ "agent jobs", "list", "monitoring" ] -tag: "deprecated" - ---- - -This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead. - -## Usage - -This endpoint retrieves all agent jobs for the specified domain, providing an overview of all agent activities and their current status. This is useful for monitoring and managing multiple concurrent or historical agent jobs. - -## Response - -Use this endpoint to get a comprehensive view of all previous agent sessions. diff --git a/api/agent/v2/create-agent-job.mdx b/api/agent/v2/create-agent-job.mdx deleted file mode 100644 index ef6cd683c1..0000000000 --- a/api/agent/v2/create-agent-job.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Create agent job" -openapi: /admin-openapi.json POST /v2/agent/{projectId}/job -keywords: ["agent job", "create", "automation", "automate"] - ---- - -This endpoint creates a background agent job. The job runs asynchronously — use the [get agent job](/api/agent/v2/get-agent-job) endpoint to poll for status updates. - -If the agent edits files successfully, Mintlify creates a pull request and populates the `prLink` field in the job response. - -## Rate limits - -- 100 uses per Mintlify project per hour - -## Usage - -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Add a quickstart guide for the Python SDK"}' -``` diff --git a/api/agent/v2/get-agent-job.mdx b/api/agent/v2/get-agent-job.mdx deleted file mode 100644 index 6fcc6650a5..0000000000 --- a/api/agent/v2/get-agent-job.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Get agent job" -openapi: /admin-openapi.json GET /v2/agent/{projectId}/job/{id} -keywords: ["agent job", "status", "retrieve", "details", "poll"] - ---- - -Poll this endpoint to track the progress of an agent job. The `status` field transitions through `active` → `completed` or `failed`. - -After the agent creates a pull request, the `prLink` field contains the link. diff --git a/api/agent/v2/send-message.mdx b/api/agent/v2/send-message.mdx deleted file mode 100644 index 06663c457d..0000000000 --- a/api/agent/v2/send-message.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Send follow-up message" -openapi: /admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message -keywords: ["agent job", "message", "follow-up", "send"] - ---- - -Send a follow-up instruction to an existing agent job. The agent processes the message asynchronously. Poll the [get agent job](/api/agent/v2/get-agent-job) endpoint to track progress. - -## Rate limits - -- 100 uses per Mintlify project per hour - -## Usage - -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Also add error handling examples to the quickstart guide"}' -``` diff --git a/api/analytics/assistant-caller-stats.mdx b/api/analytics/assistant-caller-stats.mdx deleted file mode 100644 index 377fd12c29..0000000000 --- a/api/analytics/assistant-caller-stats.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Get assistant caller stats" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats -keywords: ["analytics", "assistant", "caller", "stats", "export"] - ---- - -## Usage - -Use this endpoint to see how the system distributes assistant queries across different caller types. The response breaks down total queries into: - -- **web**: Queries from the documentation site -- **api**: Queries from direct API calls -- **other**: Queries from other sources (for example, integrations, SDKs) -- **total**: Sum of all query types - -## Filtering - -Filter by date range using `dateFrom` and `dateTo` parameters. diff --git a/api/analytics/assistant-conversations.mdx b/api/analytics/assistant-conversations.mdx deleted file mode 100644 index 14c33ae961..0000000000 --- a/api/analytics/assistant-conversations.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Get assistant conversations" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant -keywords: ["analytics", "assistant", "conversations", "export", "AI"] - ---- - -## Usage - -Use this endpoint to export AI assistant conversation history from your documentation. Each conversation includes the user query, assistant response, sources cited, resolution status, and query category. - -Paginate through results using the `cursor` parameter returned in the response. Continue fetching while `hasMore` is `true`. - -## Filtering - -Filter conversations by date range using `dateFrom` and `dateTo` parameters. - -## Conversation data - -Each conversation includes: -- **query**: The user's question -- **response**: The assistant's answer -- **sources**: Pages referenced in the response, with title and URL -- **resolutionStatus**: Whether the assistant successfully answered the question. Either `answered` or `unanswered`. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve. -- **queryCategory**: Classification of the query type (if available) diff --git a/api/analytics/feedback-by-page.mdx b/api/analytics/feedback-by-page.mdx deleted file mode 100644 index 02a299f4eb..0000000000 --- a/api/analytics/feedback-by-page.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Get feedback by page" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page -keywords: ["analytics", "feedback", "export", "by page", "aggregated"] - ---- - -## Usage - -Use this endpoint to export user feedback aggregated by documentation page path. Each entry shows the total feedback count for a page, broken down by type. - -## Filtering - -Filter feedback by: -- **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period -- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types -- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed` - diff --git a/api/analytics/feedback.mdx b/api/analytics/feedback.mdx deleted file mode 100644 index cffca87ea6..0000000000 --- a/api/analytics/feedback.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Get feedback" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback -keywords: ["analytics", "feedback", "export", "user feedback"] - ---- - -## Usage - -Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings, code snippet feedback, and agent feedback. - -Paginate through results using the `cursor` parameter returned in the response. Continue fetching while `hasMore` is `true`. - -## Filtering - -Filter feedback by: -- **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period -- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types -- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed` - -## Response types - -The response contains different feedback types based on the source: - -- **Contextual feedback**: Includes `helpful` boolean and optional `contact` email -- **Code snippet feedback**: Includes `code`, `filename`, and `lang` fields -- **Agent feedback**: Includes a `comment` with the agent's feedback text and the `path` of the page it relates to diff --git a/api/analytics/searches.mdx b/api/analytics/searches.mdx deleted file mode 100644 index 33dfb889ca..0000000000 --- a/api/analytics/searches.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Get search queries" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/searches -keywords: ["analytics", "search", "export", "queries", "search terms"] - ---- - -## Usage - -Use this endpoint to export documentation search analytics. Results are ordered by hit count descending, showing which terms your users search for most. - -Paginate through results using the `nextCursor` parameter returned in the response. Continue fetching while `nextCursor` is not null. - -## Filtering - -Filter search data by date range using `dateFrom` and `dateTo` parameters. - diff --git a/api/analytics/views.mdx b/api/analytics/views.mdx deleted file mode 100644 index cdb50bfeae..0000000000 --- a/api/analytics/views.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Get page views" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/views -keywords: ["analytics", "views", "page views", "traffic", "export"] - ---- - -## Usage - -Use this endpoint to export page view analytics. Results include both site-wide totals and per-page breakdowns, split by human and AI traffic. - -Paginate through results using offset-based pagination. Increment `offset` by `limit` while `hasMore` is true. - -## Filtering - -Filter view data by date range using `dateFrom` and `dateTo` parameters. - diff --git a/api/analytics/visitors.mdx b/api/analytics/visitors.mdx deleted file mode 100644 index 5efb335650..0000000000 --- a/api/analytics/visitors.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Get unique visitors" -openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/visitors -keywords: ["analytics", "visitors", "unique visitors", "traffic", "export"] - ---- - -## Usage - -Use this endpoint to export unique visitor analytics. Results include both site-wide totals and per-page breakdowns, split by human and AI traffic. The `total` field is deduplicated across human and AI traffic. - -Paginate through results using offset-based pagination. Increment `offset` by `limit` while `hasMore` is true. - -## Filtering - -Filter visitor data by date range using `dateFrom` and `dateTo` parameters. - diff --git a/api/assistant/create-assistant-message-v2.mdx b/api/assistant/create-assistant-message-v2.mdx deleted file mode 100644 index e0af95cb14..0000000000 --- a/api/assistant/create-assistant-message-v2.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "Create assistant message" -openapi: /discovery-openapi.json POST /v2/assistant/{domain}/message -keywords: - [ - "assistant message", - "embed", - "chat", - "integrate", - "v2", - "ai sdk v5", - "ai sdk v6", - ] - ---- - - - The assistant message v2 endpoint is compatible with **AI SDK v5+**. If you - use AI SDK v4, use the [assistant message v1 - endpoint](/api/assistant/create-assistant-message) instead. - - -## Integration with `useChat` - -The `useChat` hook from Vercel's AI SDK is the recommended way to integrate the assistant API into your application. - - - - -```bash -npm i ai@^6 @ai-sdk/react -``` - - - - -```tsx -import { useState } from "react"; -import { useChat } from "@ai-sdk/react"; -import { DefaultChatTransport } from "ai"; - -function MyComponent({ domain }) { - const [input, setInput] = useState(""); - - const { messages, sendMessage } = useChat({ - transport: new DefaultChatTransport({ - api: `https://api.mintlify.com/discovery/v2/assistant/${domain}/message`, - headers: { - Authorization: `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: "anonymous", - retrievalPageSize: 5, - context: [ - { - type: "code", - value: 'const example = "code snippet";', - elementId: "code-block-1", - }, - ], - }, - }), - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === "user" ? "User: " : "Assistant: "} - {message.parts - .filter((part) => part.type === "text") - .map((part) => part.text) - .join("")} -
- ))} -
{ - e.preventDefault(); - if (input.trim()) { - sendMessage({ text: input }); - setInput(""); - } - }} - > - setInput(e.target.value)} /> - -
-
- ); -} -``` - -**Required configuration:** - -- `transport` - Use `DefaultChatTransport` to configure the API connection. -- `body.fp` - Fingerprint identifier (use `'anonymous'` or a unique user identifier). -- `body.retrievalPageSize` - Number of search results to use (recommended: 5). - -**Optional configuration:** - -- `body.context` - Array of contextual information to provide to the assistant. Each context object contains: - - `type` - Either `'code'` or `'textSelection'`. - - `value` - The code snippet or selected text content. - - `path` (optional) - Path to the source file or page. - - `elementId` (optional) - Identifier for the UI element containing the context. -- `body.currentPath` - The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters. - - - - -See [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) and [Transport](https://ai-sdk.dev/docs/ai-sdk-ui/transport) in the AI SDK documentation for more details. - -## Rate limits - -The assistant API has the following limits: - -- 10,000 requests per Mintlify organization per hour -- 10,000 requests per IP per day diff --git a/api/assistant/create-assistant-message.mdx b/api/assistant/create-assistant-message.mdx deleted file mode 100644 index e64593511d..0000000000 --- a/api/assistant/create-assistant-message.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Create assistant message (v1)" -openapi: /discovery-openapi.json POST /v1/assistant/{domain}/message -tag: "Deprecated" -keywords: [ "assistant message", "embed", "chat", "integrate", "ai sdk v4" ] - ---- -Deprecated - - - The assistant message v1 endpoint is compatible with **AI SDK v4**. If you use AI SDK v5 or later, use the [assistant message v2 endpoint](/api/assistant/create-assistant-message-v2) instead. - - -## Integration with `useChat` - -The `useChat` hook from Vercel's AI SDK is the recommended way to integrate the assistant API into your application. - - - - -```bash -npm i ai@^4.1.15 -``` - - - - -```tsx -import { useChat } from 'ai/react'; - -function MyComponent({ domain }) { - const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({ - api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`, - headers: { - 'Authorization': `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: 'anonymous', - retrievalPageSize: 5, - context: [ - { - type: 'code', - value: 'const example = "code snippet";', - elementId: 'code-block-1', - }, - ], - }, - streamProtocol: 'data', - sendExtraMessageFields: true, - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === 'user' ? 'User: ' : 'Assistant: '} - {message.content} -
- ))} -
- - -
-
- ); -} -``` - -**Required configuration for Mintlify:** -- `streamProtocol: 'data'` - Required for streaming responses. -- `sendExtraMessageFields: true` - Required to send message metadata. -- `body.fp` - Fingerprint identifier (use 'anonymous' or a user identifier). -- `body.retrievalPageSize` - Number of search results to use (recommended: 5). - -**Optional configuration:** -- `body.context` - Array of contextual information to provide to the assistant. Each context object contains: - - `type` - Either `'code'` or `'textSelection'`. - - `value` - The code snippet or selected text content. - - `elementId` (optional) - Identifier for the UI element containing the context. -- `body.currentPath` - The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters. - - - - -See [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) in the AI SDK documentation for more details. - -## Rate limits - -The assistant API has the following limits: - -- 10,000 requests per Mintlify organization per hour -- 10,000 requests per IP per day diff --git a/api/assistant/get-page-content.mdx b/api/assistant/get-page-content.mdx deleted file mode 100644 index e64e3772c6..0000000000 --- a/api/assistant/get-page-content.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get page content" -openapi: "/discovery-openapi.json POST /v1/page/{domain}" -keywords: [ "page", "content", "retrieve" ] - ---- - -## Rate limits -- 10,000 requests per Mintlify organization per hour diff --git a/api/assistant/search.mdx b/api/assistant/search.mdx deleted file mode 100644 index c1b048a4f8..0000000000 --- a/api/assistant/search.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Search documentation" -openapi: "/discovery-openapi.json POST /v1/search/{domain}" -keywords: [ "search", "query" ] - ---- - -## Rate limits - -- 10,000 requests per Mintlify organization per hour diff --git a/api/introduction.mdx b/api/introduction.mdx index a163fdebf0..c9ae06e3f0 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -9,31 +9,31 @@ The Mintlify REST (Representational State Transfer) API enables you to programma ## Endpoints -- [Trigger update](/api/update/trigger): Trigger an update of your site when desired. -- [Get update status](/api/update/status): Get the status of an update and other details about your docs. -- [Trigger preview deployment](/api/preview/trigger): Create or update a preview deployment for a specific branch. -- [Create agent job](/api/agent/v2/create-agent-job): Create an agent job to automatically edit your documentation. -- [Get agent job](/api/agent/v2/get-agent-job): Retrieve the details and status of a specific agent job. -- [Send follow-up message](/api/agent/v2/send-message): Send a follow-up message to an existing agent job. -- [Create assistant message](/api/assistant/create-assistant-message-v2): Embed the assistant, trained on your docs, into any application of your choosing. -- [Search documentation](/api/assistant/search): Search through your documentation. +- [Trigger update](/api/admin/trigger-update): Trigger an update of your site when desired. +- [Get update status](/api/admin/get-update-status): Get the status of an update and other details about your docs. +- [Trigger preview deployment](/api/admin/trigger-preview-deployment): Create or update a preview deployment for a specific branch. +- [Create agent job](/api/agent/create-agent-job): Create an agent job to automatically edit your documentation. +- [Get agent job](/api/agent/get-agent-job): Retrieve the details and status of a specific agent job. +- [Send follow-up message](/api/agent/send-follow-up-message): Send a follow-up message to an existing agent job. +- [Create assistant message](/api/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing. +- [Search documentation](/api/assistant/search-documentation): Search through your documentation. - [Get page content](/api/assistant/get-page-content): Retrieve the full text content of a documentation page. -- [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation. -- [Get feedback by page](/api/analytics/feedback-by-page): Export feedback counts aggregated by page. -- [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history. -- [Get assistant caller stats](/api/analytics/assistant-caller-stats): Retrieve a breakdown of assistant query counts by caller type. -- [Get search queries](/api/analytics/searches): Export documentation search terms and analytics. -- [Get page views](/api/analytics/views): Export per-page and site-wide content view counts. -- [Get unique visitors](/api/analytics/visitors): Export per-page and site-wide unique visitor counts. +- [Get user feedback](/api/analytics/get-feedback): Export user feedback from your documentation. +- [Get feedback by page](/api/analytics/get-feedback-by-page): Export feedback counts aggregated by page. +- [Get assistant conversations](/api/analytics/get-assistant-conversations): Export AI assistant conversation history. +- [Get assistant caller stats](/api/analytics/get-assistant-caller-stats): Retrieve a breakdown of assistant query counts by caller type. +- [Get search queries](/api/analytics/get-search-queries): Export documentation search terms and analytics. +- [Get page views](/api/analytics/get-page-views): Export per-page and site-wide content view counts. +- [Get unique visitors](/api/analytics/get-unique-visitors): Export per-page and site-wide unique visitor counts. ### Common use cases -- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status). -- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger). -- **Preview deployments**: Create or update preview deployments programmatically in your CI/CD pipeline with [Trigger preview deployment](/api/preview/trigger). -- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message-v2), [Search documentation](/api/assistant/search), and [Get page content](/api/assistant/get-page-content). -- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), and [Send follow-up message](/api/agent/v2/send-message). -- **Analytics export**: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors). +- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/admin/trigger-update) and [Get update status](/api/admin/get-update-status). +- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/admin/trigger-update). +- **Preview deployments**: Create or update preview deployments programmatically in your CI/CD pipeline with [Trigger preview deployment](/api/admin/trigger-preview-deployment). +- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message), [Search documentation](/api/assistant/search-documentation), and [Get page content](/api/assistant/get-page-content). +- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Send follow-up message](/api/agent/send-follow-up-message). +- **Analytics export**: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with [Get user feedback](/api/analytics/get-feedback), [Get feedback by page](/api/analytics/get-feedback-by-page), [Get assistant conversations](/api/analytics/get-assistant-conversations), [Get assistant caller stats](/api/analytics/get-assistant-caller-stats), [Get search queries](/api/analytics/get-search-queries), [Get page views](/api/analytics/get-page-views), and [Get unique visitors](/api/analytics/get-unique-visitors). ## Authentication @@ -43,15 +43,15 @@ You can create up to 10 API keys per hour per organization. ### Admin API key -Use the admin API key to authenticate requests to [Trigger update](/api/update/trigger), [Get update status](/api/update/status), [Trigger preview deployment](/api/preview/trigger), [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), [Send follow-up message](/api/agent/v2/send-message), [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors). +Use the admin API key to authenticate requests to [Trigger update](/api/admin/trigger-update), [Get update status](/api/admin/get-update-status), [Trigger preview deployment](/api/admin/trigger-preview-deployment), [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), [Send follow-up message](/api/agent/send-follow-up-message), [Get user feedback](/api/analytics/get-feedback), [Get feedback by page](/api/analytics/get-feedback-by-page), [Get assistant conversations](/api/analytics/get-assistant-conversations), [Get assistant caller stats](/api/analytics/get-assistant-caller-stats), [Get search queries](/api/analytics/get-search-queries), [Get page views](/api/analytics/get-page-views), and [Get unique visitors](/api/analytics/get-unique-visitors). -Admin API keys begin with the `mint_` prefix. +Admin API keys begin with the `mint_` prefix. The admin API key is a server-side secret. Do not expose it in client-side code. ### Assistant API key -Use the assistant API key to authenticate requests to [Create assistant message](/api/assistant/create-assistant-message-v2), [Search documentation](/api/assistant/search), and [Get page content](/api/assistant/get-page-content) endpoints. +Use the assistant API key to authenticate requests to [Create assistant message](/api/assistant/create-assistant-message), [Search documentation](/api/assistant/search-documentation), and [Get page content](/api/assistant/get-page-content) endpoints. Assistant API keys begin with the `mint_dsc_` prefix. @@ -59,4 +59,4 @@ The assistant API key is a public token that you can reference in frontend code. Calls using the assistant API token can incur costs: either using your assistant credits or incurring overages. - + \ No newline at end of file diff --git a/api/preview/trigger.mdx b/api/preview/trigger.mdx deleted file mode 100644 index 5144977183..0000000000 --- a/api/preview/trigger.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Trigger preview deployment" -openapi: "/openapi.json POST /project/preview/{projectId}" -keywords: ["preview", "preview deployment", "branch preview", "staging"] - ---- - -Use this endpoint to programmatically create or update a preview deployment for a Git branch. If a preview already exists for the specified branch, the endpoint triggers a redeployment instead of creating a duplicate. - -The response includes a `statusId` that you can pass to [Get deployment status](/api/update/status) to track the deployment progress. - -## Use cases - -- **CI/CD pipelines**: Automatically create preview deployments when users open or update pull requests. -- **Scheduled previews**: Build previews from long-running feature branches on a schedule. -- **Custom tooling**: Integrate preview creation into internal workflows or Slack bots. - -## Rate limits - -This endpoint allows up to 5 requests per minute per organization. diff --git a/api/update/status.mdx b/api/update/status.mdx deleted file mode 100644 index b7c9ba75b0..0000000000 --- a/api/update/status.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Get deployment status" -openapi: "/openapi.json GET /project/update-status/{statusId}" -keywords: [ "update status", "deployment status", "check status" ] - ---- diff --git a/api/update/trigger.mdx b/api/update/trigger.mdx deleted file mode 100644 index 44fe1c86f9..0000000000 --- a/api/update/trigger.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Trigger deployment" -openapi: "/openapi.json POST /project/update/{projectId}" -keywords: [ "trigger", "update", "deployment", "programmatic" ] - ---- diff --git a/discovery-openapi.json b/discovery-openapi.json index 89c64242e9..7b7b42e10b 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -19,6 +19,8 @@ "/v1/assistant/{domain}/message": { "post": { "summary": "Assistant message v1", + "deprecated": true, + "x-hidden": true, "description": "Generates a response message from the assistant for the specified domain. Compatible with AI SDK v4.", "parameters": [ { diff --git a/docs.json b/docs.json index f2051ed4c1..a03b1f1c6d 100644 --- a/docs.json +++ b/docs.json @@ -375,42 +375,22 @@ { "group": "Admin", "icon": "activity", - "pages": [ - "api/update/trigger", - "api/update/status", - "api/preview/trigger" - ] + "openapi": "openapi.json" }, { "group": "Agent", "icon": "pen-line", - "pages": [ - "api/agent/v2/create-agent-job", - "api/agent/v2/get-agent-job", - "api/agent/v2/send-message" - ] + "openapi": "admin-openapi.json" }, { "group": "Assistant", "icon": "bot-message-square", - "pages": [ - "api/assistant/create-assistant-message-v2", - "api/assistant/search", - "api/assistant/get-page-content" - ] + "openapi": "discovery-openapi.json" }, { "group": "Analytics", "icon": "chart-line", - "pages": [ - "api/analytics/feedback", - "api/analytics/feedback-by-page", - "api/analytics/assistant-conversations", - "api/analytics/assistant-caller-stats", - "api/analytics/searches", - "api/analytics/views", - "api/analytics/visitors" - ] + "openapi": "analytics.openapi.json" } ] }, diff --git a/es.json b/es.json index 241008091c..99009e4373 100644 --- a/es.json +++ b/es.json @@ -342,38 +342,22 @@ { "group": "Administración", "icon": "activity", - "pages": [ - "es/api/update/trigger", - "es/api/update/status", - "es/api/preview/trigger" - ] + "openapi": "es/openapi.json" }, { "group": "Agente", "icon": "pen-line", - "pages": [ - "es/api/agent/v2/create-agent-job", - "es/api/agent/v2/get-agent-job", - "es/api/agent/v2/send-message" - ] + "openapi": "es/admin-openapi.json" }, { "group": "assistant", "icon": "bot-message-square", - "pages": [ - "es/api/assistant/create-assistant-message-v2", - "es/api/assistant/search", - "es/api/assistant/get-page-content" - ] + "openapi": "es/discovery-openapi.json" }, { "group": "Analytics", "icon": "chart-line", - "pages": [ - "es/api/analytics/feedback", - "es/api/analytics/assistant-conversations", - "es/api/analytics/assistant-caller-stats" - ] + "openapi": "es/analytics.openapi.json" } ] }, diff --git a/es/admin-openapi.json b/es/admin-openapi.json index 8d221a9a05..575b36de50 100644 --- a/es/admin-openapi.json +++ b/es/admin-openapi.json @@ -20,6 +20,7 @@ "post": { "summary": "Crear trabajo del agente (v1)", "deprecated": true, + "x-hidden": true, "description": "En desuso: usa [v2 create agent job](/api/agent/v2/create-agent-job) en su lugar. Crea un nuevo trabajo del agente que puede generar y editar documentación según los mensajes proporcionados y la información de la branch.", "parameters": [ { @@ -124,6 +125,7 @@ "get": { "summary": "Obtener trabajo del agente por ID (v1)", "deprecated": true, + "x-hidden": true, "description": "En desuso: usa [v2 get agent job](/api/agent/v2/get-agent-job) en su lugar. Recupera los detalles y el estado de un trabajo del agente específico a partir de su ID.", "parameters": [ { @@ -250,6 +252,7 @@ "get": { "summary": "Obtener todos los trabajos del agente (v1)", "deprecated": true, + "x-hidden": true, "description": "En desuso: usa [v2 get agent job](/api/agent/v2/get-agent-job) en su lugar. Recupera todas las tareas del agente para el domain especificado, incluido su estado y sus detalles.", "parameters": [ { diff --git a/es/api/agent/create-agent-job.mdx b/es/api/agent/create-agent-job.mdx deleted file mode 100644 index f7bb6e7fe8..0000000000 --- a/es/api/agent/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Crear trabajo del agente (v1)" -openapi: /es/admin-openapi.json POST /v1/agent/{projectId}/job -keywords: [ "trabajo del agente", "crear", "automatización", "automatizar" ] -tag: "deprecated" ---- - -Este endpoint está en desuso. Usa el endpoint [crear trabajo del agente v2](/es/api/agent/v2/create-agent-job) en su lugar. - -Este endpoint crea un trabajo del agente a partir de los mensajes proporcionados y la información de la branch. El trabajo se ejecuta de forma asíncrona y devuelve una respuesta en streaming con los detalles de la ejecución y los resultados. - -Si no existe una branch, el agente crea una. Si los archivos se editan correctamente, al finalizar el trabajo se crea automáticamente una solicitud de extracción. - -
- ## Límites de tasa -
- -La API del agente tiene los siguientes límites: - -* 100 usos por proyecto de Mintlify por hora - -
- ## Uso recomendado -
- -Para obtener mejores resultados, utiliza el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar las respuestas. \ No newline at end of file diff --git a/es/api/agent/get-agent-job.mdx b/es/api/agent/get-agent-job.mdx deleted file mode 100644 index 3ba4143dab..0000000000 --- a/es/api/agent/get-agent-job.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Obtener trabajo de agente (v1)" -openapi: /es/admin-openapi.json GET /v1/agent/{projectId}/job/{id} -keywords: [ "trabajo de agente", "estado", "obtener", "detalles" ] -tag: "deprecated" ---- - -Este endpoint está en desuso. Usa en su lugar el endpoint [v2 obtener trabajo de agente](/es/api/agent/v2/get-agent-job). - -
- ## Uso -
- -Este endpoint obtiene los detalles y el estado de un trabajo de agente específico mediante su identificador único. Úsalo para comprobar el progreso, el estado y los resultados de un trabajo de agente creado previamente. - -
- ## Detalles del trabajo -
- -La respuesta incluye información como: - -* Estado de ejecución del trabajo y estado de finalización -* Información de la branch y detalles de la solicitud de extracción -* metadata de la sesión y marcas de tiempo \ No newline at end of file diff --git a/es/api/agent/get-all-jobs.mdx b/es/api/agent/get-all-jobs.mdx deleted file mode 100644 index cdcb09f40c..0000000000 --- a/es/api/agent/get-all-jobs.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Listar trabajos del agente (v1)" -openapi: /es/admin-openapi.json GET /v1/agent/{projectId}/jobs -keywords: [ "trabajos del agente", "listar", "monitoreo" ] -tag: "deprecated" ---- - -Este endpoint está en desuso. Usa el endpoint [v2 get agent job](/es/api/agent/v2/get-agent-job) en su lugar. - -
- ## Uso -
- -Este endpoint obtiene todos los trabajos del agente para el domain especificado, ofreciendo una visión general de todas las actividades del agente y su estado actual. Es útil para supervisar y gestionar múltiples trabajos del agente, tanto concurrentes como históricos. - -
- ## Respuesta -
- -Utilice este endpoint para obtener una vista completa de todas las sesiones anteriores del agente. \ No newline at end of file diff --git a/es/api/agent/v2/create-agent-job.mdx b/es/api/agent/v2/create-agent-job.mdx deleted file mode 100644 index 2f457c58a8..0000000000 --- a/es/api/agent/v2/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Crear tarea de agente" -openapi: /es/admin-openapi.json POST /v2/agent/{projectId}/job -keywords: [ "tarea de agente", "crear", "automatización", "automatizar" ] ---- - -Este endpoint crea una tarea de agente en segundo plano. La tarea se ejecuta de forma asíncrona; usa el endpoint [get agent job](/es/api/agent/v2/get-agent-job) para consultar las actualizaciones de estado. - -Si el agente edita los archivos correctamente, se crea automáticamente una solicitud de extracción y se rellena el campo `prLink` en la respuesta de la tarea. - -
- ## Límites de uso -
- -* 100 usos por hora por proyecto de Mintlify - -
- ## Uso -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Add a quickstart guide for the Python SDK"}' -``` diff --git a/es/api/agent/v2/get-agent-job.mdx b/es/api/agent/v2/get-agent-job.mdx deleted file mode 100644 index edd234f6ac..0000000000 --- a/es/api/agent/v2/get-agent-job.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Obtener tarea del agente" -openapi: /es/admin-openapi.json GET /v2/agent/{projectId}/job/{id} -keywords: - [ - "tarea del agente", - "estado", - "recuperar", - "detalles", - "consulta periódica" - ] ---- - -Consulta periódicamente este endpoint para hacer seguimiento del progreso de una tarea del agente. El campo `status` pasa de `active` a `completed` o `failed`. - -Una vez que el agente crea una solicitud de extracción, el campo `prLink` se completa. \ No newline at end of file diff --git a/es/api/agent/v2/send-message.mdx b/es/api/agent/v2/send-message.mdx deleted file mode 100644 index 0cfa8b26ae..0000000000 --- a/es/api/agent/v2/send-message.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Enviar un mensaje de seguimiento" -openapi: /es/admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message -keywords: [ "tarea de agente", "mensaje", "seguimiento", "enviar" ] ---- - -Envía una instrucción de seguimiento a una tarea de agente existente. El mensaje se procesa de forma asíncrona; consulta el endpoint [obtener la tarea de agente](/es/api/agent/v2/get-agent-job) para seguir su progreso. - -
- ## Límites de uso -
- -* 100 usos por proyecto de Mintlify por hora - -
- ## Uso -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Also add error handling examples to the quickstart guide"}' -``` diff --git a/es/api/analytics/assistant-caller-stats.mdx b/es/api/analytics/assistant-caller-stats.mdx deleted file mode 100644 index 9830719c3f..0000000000 --- a/es/api/analytics/assistant-caller-stats.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Obtener estadísticas de llamadas del assistant" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats -keywords: ["analytics", "assistant", "caller", "stats", "export"] ---- - -
- ## Uso -
- -Utiliza este endpoint para ver cómo se distribuyen las consultas del assistant entre los diferentes tipos de origen. La respuesta desglosa el total de consultas en: - -- **web**: Consultas desde el sitio de documentación -- **api**: Consultas desde llamadas directas a la API -- **other**: Consultas desde otras fuentes (por ejemplo, integraciones, SDKs) -- **total**: Suma de todos los tipos de consulta - -
- ## Filtrado -
- -Filtra por rango de fechas usando los parámetros `dateFrom` y `dateTo`. diff --git a/es/api/analytics/assistant-conversations.mdx b/es/api/analytics/assistant-conversations.mdx deleted file mode 100644 index 7814b7d72e..0000000000 --- a/es/api/analytics/assistant-conversations.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Obtener conversaciones del assistant" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/assistant -keywords: [ "analytics", "assistant", "conversations", "export", "AI" ] ---- - -
- ## Uso -
- -Utiliza este endpoint para exportar el historial de conversaciones del Asistente de IA desde tu documentación. Cada conversación incluye la búsqueda del usuario, la respuesta del Asistente de IA, las fuentes citadas, el estado de resolución y la categoría de la búsqueda. - -Pagina los resultados usando el parámetro `cursor` devuelto en la respuesta. Continúa obteniendo resultados mientras `hasMore` sea `true`. - -
- ## Filtrado -
- -Filtra conversaciones por intervalo de fechas usando los parámetros `dateFrom` y `dateTo`. - -
- ## Datos de conversación -
- -Cada conversación incluye: - -- **query**: La pregunta del usuario -- **response**: La respuesta del assistant -- **sources**: Páginas a las que se hace referencia en la respuesta, con título y URL -- **resolutionStatus**: Indica si el assistant respondió correctamente a la pregunta. Puede ser `answered` o `unanswered`. Usa este campo para identificar y analizar lagunas en la documentación detectadas a partir de preguntas de usuarios que el assistant no pudo resolver. -- **queryCategory**: Clasificación del tipo de búsqueda (si está disponible) \ No newline at end of file diff --git a/es/api/analytics/feedback-by-page.mdx b/es/api/analytics/feedback-by-page.mdx deleted file mode 100644 index e3278942d5..0000000000 --- a/es/api/analytics/feedback-by-page.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Obtener comentarios por página" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page -keywords: [ "Analytics", "feedback", "exportación", "por página", "agregado" ] ---- - -
- ## Uso -
- -Usa este endpoint para exportar los comentarios de los usuarios agregados por ruta de página de documentación. Cada entrada muestra el recuento total de comentarios de una página, desglosado por tipo. - -
- ## Filtrado -
- -Filtra los comentarios por: - -- **Rango de fechas**: Utiliza `dateFrom` y `dateTo` para limitar los resultados a un período de tiempo específico -- **Fuente**: Filtra por tipos de feedback `code_snippet`, `contextual` o `agent` -- **Estado**: Filtra por valores de estado como `pending`, `in_progress`, `resolved` o `dismissed` diff --git a/es/api/analytics/feedback.mdx b/es/api/analytics/feedback.mdx deleted file mode 100644 index 37f4dd49c2..0000000000 --- a/es/api/analytics/feedback.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Obtener comentarios" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/feedback -keywords: [ "Analytics", "feedback", "exportación", "comentarios de los usuarios" ] ---- - -
- ## Uso -
- -Usa este endpoint para exportar los comentarios de los usuarios recopilados desde tu documentación. Los comentarios incluyen comentarios contextuales de las calificaciones de las páginas, comentarios sobre fragmentos de código y comentarios de agentes. - -Pagina los resultados usando el parámetro `cursor` devuelto en la respuesta. Continúa obteniendo resultados mientras `hasMore` sea `true`. - -
- ## Filtrado -
- -Filtra los comentarios por: - -- **Rango de fechas**: Utiliza `dateFrom` y `dateTo` para limitar los resultados a un período de tiempo específico -- **Fuente**: Filtra por tipos de feedback `code_snippet`, `contextual` o `agent` -- **Estado**: Filtra por valores de estado como `pending`, `in_progress`, `resolved` o `dismissed` - -
- ## Tipos de respuesta -
- -La respuesta contiene diferentes tipos de comentarios según la fuente: - -- **Comentarios contextuales**: Incluyen el valor booleano `helpful` y un correo electrónico opcional en `contact` -- **Comentarios sobre fragmentos de código**: Incluyen los campos `code`, `filename` y `lang` -- **Comentarios de agentes**: Incluyen un `comment` con el texto del comentario del agente y el `path` de la página a la que se refiere \ No newline at end of file diff --git a/es/api/analytics/searches.mdx b/es/api/analytics/searches.mdx deleted file mode 100644 index 5df22843d7..0000000000 --- a/es/api/analytics/searches.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtener consultas de búsqueda" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/searches -keywords: [ "Analytics", "búsqueda", "exportación", "consultas", "términos de búsqueda" ] ---- - -
- ## Uso -
- -Usa este endpoint para exportar el análisis de búsqueda de la documentación. Los resultados se ordenan de mayor a menor número de resultados, mostrando los términos que más buscan tus usuarios. - -Pagina los resultados usando el parámetro `nextCursor` devuelto en la respuesta. Continúa obteniendo resultados mientras `nextCursor` no sea nulo. - -
- ## Filtrado -
- -Filtra los datos de búsqueda por rango de fechas usando los parámetros `dateFrom` y `dateTo`. diff --git a/es/api/analytics/views.mdx b/es/api/analytics/views.mdx deleted file mode 100644 index e6b6409679..0000000000 --- a/es/api/analytics/views.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtener vistas de página" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/views -keywords: [ "Analytics", "vistas", "vistas de página", "tráfico", "exportación" ] ---- - -
- ## Uso -
- -Usa este endpoint para exportar el análisis de vistas de página. Los resultados incluyen totales del sitio completo y desgloses por página, divididos entre tráfico humano y de IA. - -Pagina los resultados usando paginación basada en desplazamiento. Incrementa `offset` en `limit` mientras `hasMore` sea `true`. - -
- ## Filtrado -
- -Filtra los datos de vistas por rango de fechas usando los parámetros `dateFrom` y `dateTo`. diff --git a/es/api/analytics/visitors.mdx b/es/api/analytics/visitors.mdx deleted file mode 100644 index 7207519b36..0000000000 --- a/es/api/analytics/visitors.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtener visitantes únicos" -openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/visitors -keywords: [ "Analytics", "visitantes", "visitantes únicos", "tráfico", "exportación" ] ---- - -
- ## Uso -
- -Usa este endpoint para exportar el análisis de visitantes únicos. Los resultados incluyen totales del sitio completo y desgloses por página, divididos entre tráfico humano y de IA. El campo `total` se deduplica entre el tráfico humano y el de IA. - -Pagina los resultados usando paginación basada en desplazamiento. Incrementa `offset` en `limit` mientras `hasMore` sea `true`. - -
- ## Filtrado -
- -Filtra los datos de visitantes por rango de fechas usando los parámetros `dateFrom` y `dateTo`. diff --git a/es/api/assistant/create-assistant-message-v2.mdx b/es/api/assistant/create-assistant-message-v2.mdx deleted file mode 100644 index b9cf714972..0000000000 --- a/es/api/assistant/create-assistant-message-v2.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Crear mensaje de assistant" -openapi: /es/discovery-openapi.json POST /v2/assistant/{domain}/message -keywords: - [ - "mensaje de assistant", - "incrustar", - "chat", - "integrar", - "v2", - "ai sdk v5", - "ai sdk v6" - ] ---- - - - El endpoint de mensaje de assistant v2 es compatible con **AI SDK v5 o superior**. Si usas AI SDK v4, utiliza en su lugar el [endpoint de mensaje de assistant v1](/es/api/assistant/create-assistant-message). - - -
- ## Integración con `useChat` -
- -El hook `useChat` del AI SDK de Vercel es la forma recomendada de integrar la assistant API en tu aplicación. - - - - ```bash - npm i ai@^6 @ai-sdk/react - ``` - - - - ```tsx - import { useState } from "react"; - import { useChat } from "@ai-sdk/react"; - import { DefaultChatTransport } from "ai"; - - function MyComponent({ domain }) { - const [input, setInput] = useState(""); - - const { messages, sendMessage } = useChat({ - transport: new DefaultChatTransport({ - api: `https://api.mintlify.com/discovery/v2/assistant/${domain}/message`, - headers: { - Authorization: `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: "anonymous", - retrievalPageSize: 5, - context: [ - { - type: "code", - value: 'const example = "code snippet";', - elementId: "code-block-1", - }, - ], - }, - }), - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === "user" ? "User: " : "Assistant: "} - {message.parts - .filter((part) => part.type === "text") - .map((part) => part.text) - .join("")} -
- ))} -
{ - e.preventDefault(); - if (input.trim()) { - sendMessage({ text: input }); - setInput(""); - } - }} - > - setInput(e.target.value)} /> - -
-
- ); - } - ``` - - **Configuración obligatoria:** - - * `transport` - Usa `DefaultChatTransport` para configurar la conexión con la API. - * `body.fp` - Identificador de huella digital (usa `'anonymous'` o un identificador único de usuario). - * `body.retrievalPageSize` - Número de resultados de búsqueda que se usarán (recomendado: 5). - - **Configuración opcional:** - - * `body.context` - Array de información contextual que se le proporciona al assistant. Cada objeto de contexto contiene: - * `type` - Puede ser `'code'` o `'textSelection'`. - * `value` - El fragmento de código o el contenido de texto seleccionado. - * `path` (opcional) - Ruta al archivo o a la página de origen. - * `elementId` (opcional) - Identificador del elemento de la interfaz de usuario que contiene el contexto. - * `body.currentPath` - La ruta de la página que el usuario está viendo en ese momento. Cuando se proporciona, el assistant utiliza este contexto para ofrecer respuestas más relevantes. Longitud máxima: 200 caracteres. - - - -Consulta [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) y [Transport](https://ai-sdk.dev/docs/ai-sdk-ui/transport) en la documentación del AI SDK para más detalles. - -
- ## Límites de uso -
- -La API del assistant tiene los siguientes límites: - -* 10.000 solicitudes por organización de Mintlify por hora -* 10.000 solicitudes por IP por día \ No newline at end of file diff --git a/es/api/assistant/create-assistant-message.mdx b/es/api/assistant/create-assistant-message.mdx deleted file mode 100644 index 168bd2a457..0000000000 --- a/es/api/assistant/create-assistant-message.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "Crear mensaje del assistant (v1)" -openapi: /es/discovery-openapi.json POST /v1/assistant/{domain}/message -tag: "En desuso" -keywords: [ "mensaje del assistant", "incrustar", "chat", "integrar", "ai sdk v4" ] ---- - -En desuso - - - El endpoint assistant message v1 es compatible con **AI SDK v4**. Si utilizas AI SDK v5 o posterior, usa en su lugar el [endpoint assistant message v2](/es/api/assistant/create-assistant-message-v2). - - -
- ## Integración con `useChat` -
- -El hook `useChat` del AI SDK de Vercel es la forma recomendada de integrar la API del assistant en tu aplicación. - - - - ```bash - npm i ai@^4.1.15 - ``` - - - - ```tsx - import { useChat } from 'ai/react'; - - function MyComponent({ domain }) { - const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({ - api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`, - headers: { - 'Authorization': `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: 'anonymous', - retrievalPageSize: 5, - context: [ - { - type: 'code', - value: 'const example = "code snippet";', - elementId: 'code-block-1', - }, - ], - }, - streamProtocol: 'data', - sendExtraMessageFields: true, - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === 'user' ? 'Usuario: ' : 'Assistant: '} - {message.content} -
- ))} -
- - -
-
- ); - } - ``` - - **Configuración obligatoria para Mintlify:** - - * `streamProtocol: 'data'` - Obligatorio para respuestas en streaming. - * `sendExtraMessageFields: true` - Obligatorio para enviar metadatos de los mensajes. - * `body.fp` - Identificador de huella digital (usa 'anonymous' o un identificador de usuario). - * `body.retrievalPageSize` - Número de resultados de búsqueda que se usarán (recomendado: 5). - - **Configuración opcional:** - - * `body.context` - Array de información contextual que se proporciona al assistant. Cada objeto de contexto incluye: - * `type` - Puede ser `'code'` o `'textSelection'`. - * `value` - El fragmento de código o el contenido de texto seleccionado. - * `elementId` (opcional) - Identificador del elemento de la interfaz de usuario que contiene el contexto. - * `body.currentPath` - La ruta de la página que el usuario está viendo actualmente. Cuando se proporciona, el assistant utiliza este contexto para ofrecer respuestas más relevantes. Longitud máxima: 200 caracteres. - - - -Consulta [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) en la documentación del AI SDK para obtener más información. - -
- ## Límites de uso -
- -La API del assistant tiene los siguientes límites: - -* 10,000 solicitudes por organización de Mintlify por hora -* 10,000 solicitudes por IP al día \ No newline at end of file diff --git a/es/api/assistant/get-page-content.mdx b/es/api/assistant/get-page-content.mdx deleted file mode 100644 index 9563fb57e6..0000000000 --- a/es/api/assistant/get-page-content.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Obtener contenido de la página" -openapi: "/es/discovery-openapi.json POST /v1/page/{domain}" -keywords: [ "página", "contenido", "recuperar" ] ---- - -
-## Límites de tasa -
- -- 10,000 solicitudes por organización de Mintlify por hora diff --git a/es/api/assistant/search.mdx b/es/api/assistant/search.mdx deleted file mode 100644 index 552476d95d..0000000000 --- a/es/api/assistant/search.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Buscar en la documentación" -openapi: "/es/discovery-openapi.json POST /v1/search/{domain}" -keywords: [ "búsqueda", "query" ] ---- - -
-## Límites de tasa -
- -- 10,000 solicitudes por organización de Mintlify por hora \ No newline at end of file diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index 2d50e0658c..9c0026eeee 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -11,29 +11,29 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar ## Endpoints -* [Trigger update](/es/api/update/trigger): Activa una actualización de tu sitio cuando quieras. -* [Get update status](/es/api/update/status): Obtén el estado de una actualización y otros detalles de tu documentación. -* [Trigger preview deployment](/es/api/preview/trigger): Crea o actualiza una implementación de vista previa para una rama específica. -* [Create agent job](/es/api/agent/v2/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente. -* [Get agent job](/es/api/agent/v2/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica. -* [Send follow-up message](/es/api/agent/v2/send-message): Envía un mensaje de seguimiento a una tarea de agente existente. -* [Create assistant message](/es/api/assistant/create-assistant-message-v2): Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas. -* [Search documentation](/es/api/assistant/search): Busca en tu documentación. -* [Get page content](/es/api/assistant/get-page-content): Recupera el contenido de texto completo de una página de documentación. -* [Get user feedback](/es/api/analytics/feedback): Exporta los comentarios de los usuarios de tu documentación. -* [Get assistant conversations](/es/api/analytics/assistant-conversations): Exporta el historial de conversaciones del Asistente de IA. -* [Get assistant caller stats](/es/api/analytics/assistant-caller-stats): Obtén un desglose de los recuentos de consultas del assistant por tipo de origen. +- [Trigger update](/es/api/admin/trigger-update): Activa una actualización de tu sitio cuando quieras. +- [Get update status](/es/api/admin/get-update-status): Obtén el estado de una actualización y otros detalles de tu documentación. +- [Trigger preview deployment](/es/api/admin/trigger-preview-deployment): Crea o actualiza una implementación de vista previa para una rama específica. +- [Create agent job](/es/api/agent/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente. +- [Get agent job](/es/api/agent/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica. +- [Send follow-up message](/es/api/agent/send-follow-up-message): Envía un mensaje de seguimiento a una tarea de agente existente. +- [Create assistant message](/es/api/assistant/create-assistant-message): Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas. +- [Search documentation](/es/api/assistant/search-documentation): Busca en tu documentación. +- [Get page content](/es/api/assistant/get-page-content): Recupera el contenido de texto completo de una página de documentación. +- [Get user feedback](/es/api/analytics/get-feedback): Exporta los comentarios de los usuarios de tu documentación. +- [Get assistant conversations](/es/api/analytics/get-assistant-conversations): Exporta el historial de conversaciones del Asistente de IA. +- [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats): Obtén un desglose de los recuentos de consultas del assistant por tipo de origen.
### Casos de uso comunes
-* **Implementaciones automatizadas**: Activa actualizaciones del sitio a intervalos establecidos o cuando se produzcan eventos con [Trigger update](/es/api/update/trigger) y [Get update status](/es/api/update/status). -* **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/update/trigger). -* **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/preview/trigger). -* **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message-v2), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content). -* **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job) y [Send follow-up message](/es/api/agent/v2/send-message). -* **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). +- **Implementaciones automatizadas**: Activa actualizaciones del sitio a intervalos establecidos o cuando se produzcan eventos con [Trigger update](/es/api/admin/trigger-update) y [Get update status](/es/api/admin/get-update-status). +- **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/admin/trigger-update). +- **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/admin/trigger-preview-deployment). +- **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message), [Search documentation](/es/api/assistant/search-documentation) y [Get page content](/es/api/assistant/get-page-content). +- **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/create-agent-job), [Get agent job](/es/api/agent/get-agent-job) y [Send follow-up message](/es/api/agent/send-follow-up-message). +- **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/get-feedback), [Get assistant conversations](/es/api/analytics/get-assistant-conversations) y [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats).
## Autenticación @@ -47,7 +47,7 @@ Puedes crear hasta 10 API keys por hora y por organización. ### Clave de la API de administrador
-Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Trigger preview deployment](/es/api/preview/trigger), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). +Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/admin/trigger-update), [Get update status](/es/api/admin/get-update-status), [Trigger preview deployment](/es/api/admin/trigger-preview-deployment), [Create agent job](/es/api/agent/create-agent-job), [Get agent job](/es/api/agent/get-agent-job), [Send follow-up message](/es/api/agent/send-follow-up-message), [Get user feedback](/es/api/analytics/get-feedback), [Get assistant conversations](/es/api/analytics/get-assistant-conversations) y [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats). Las claves de la API de administrador comienzan con el prefijo `mint_`. @@ -57,7 +57,7 @@ La clave de la API de administrador es un secreto del lado del servidor. No la e ### key del Assistant API -Usa la key del Assistant API para autenticar solicitudes a los endpoints [Create assistant message](/es/api/assistant/create-assistant-message-v2), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content). +Usa la key del Assistant API para autenticar solicitudes a los endpoints [Create assistant message](/es/api/assistant/create-assistant-message), [Search documentation](/es/api/assistant/search-documentation) y [Get page content](/es/api/assistant/get-page-content). Las keys del Assistant API comienzan con el prefijo `mint_dsc_`. @@ -65,4 +65,4 @@ La key del Assistant API es un token público que puede referenciarse en tu cód Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del assistant o incurriendo en excedentes. - + \ No newline at end of file diff --git a/es/api/preview/trigger.mdx b/es/api/preview/trigger.mdx deleted file mode 100644 index 8021a55dac..0000000000 --- a/es/api/preview/trigger.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Activar implementación de vista previa" -openapi: "/es/openapi.json POST /project/preview/{projectId}" -keywords: ["preview", "preview deployment", "branch preview", "staging"] ---- - -Usa este endpoint para crear o actualizar de forma programática una implementación de vista previa para una rama de Git. Si ya existe una vista previa para la rama especificada, el endpoint activa una reimplementación en lugar de crear un duplicado. - -La respuesta incluye un `statusId` que puedes pasar a [Get deployment status](/es/api/update/status) para rastrear el progreso de la implementación. - -
- ## Casos de uso -
- -- **Pipelines CI/CD**: Crea automáticamente implementaciones de vista previa cuando se abren o actualizan solicitudes de extracción. -- **Vistas previas programadas**: Genera vistas previas de ramas de funcionalidades de larga duración de forma programada. -- **Herramientas personalizadas**: Integra la creación de vistas previas en flujos de trabajo internos o bots de Slack. - -
- ## Límites de tasa -
- -Este endpoint permite hasta 5 solicitudes por minuto por organización. diff --git a/es/api/update/status.mdx b/es/api/update/status.mdx deleted file mode 100644 index 36242de796..0000000000 --- a/es/api/update/status.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Obtener el estado de la implementación" -openapi: "/es/openapi.json GET /project/update-status/{statusId}" -keywords: [ "actualizar estado", "estado de implementación", "comprobar estado" ] ---- \ No newline at end of file diff --git a/es/api/update/trigger.mdx b/es/api/update/trigger.mdx deleted file mode 100644 index 43009756ff..0000000000 --- a/es/api/update/trigger.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Iniciar implementación" -openapi: "/es/openapi.json POST /project/update/{projectId}" -keywords: [ "disparar", "actualización", "implementación", "programático" ] ---- \ No newline at end of file diff --git a/es/discovery-openapi.json b/es/discovery-openapi.json index a44967c919..90794389f5 100644 --- a/es/discovery-openapi.json +++ b/es/discovery-openapi.json @@ -19,6 +19,8 @@ "/v1/assistant/{domain}/message": { "post": { "summary": "Mensaje del assistant v1", + "deprecated": true, + "x-hidden": true, "description": "Genera un mensaje de respuesta del assistant para el domain especificado. Compatible con AI SDK v4.", "parameters": [ { diff --git a/fr.json b/fr.json index ce442dd89f..c5ad6ae439 100644 --- a/fr.json +++ b/fr.json @@ -342,38 +342,22 @@ { "group": "Administration", "icon": "activity", - "pages": [ - "fr/api/update/trigger", - "fr/api/update/status", - "fr/api/preview/trigger" - ] + "openapi": "fr/openapi.json" }, { "group": "Agent", "icon": "pen-line", - "pages": [ - "fr/api/agent/v2/create-agent-job", - "fr/api/agent/v2/get-agent-job", - "fr/api/agent/v2/send-message" - ] + "openapi": "fr/admin-openapi.json" }, { "group": "Assistant", "icon": "bot-message-square", - "pages": [ - "fr/api/assistant/create-assistant-message-v2", - "fr/api/assistant/search", - "fr/api/assistant/get-page-content" - ] + "openapi": "fr/discovery-openapi.json" }, { "group": "Analytics", "icon": "chart-line", - "pages": [ - "fr/api/analytics/feedback", - "fr/api/analytics/assistant-conversations", - "fr/api/analytics/assistant-caller-stats" - ] + "openapi": "fr/analytics.openapi.json" } ] }, diff --git a/fr/admin-openapi.json b/fr/admin-openapi.json index 5d27a6de00..4b9336dbbc 100644 --- a/fr/admin-openapi.json +++ b/fr/admin-openapi.json @@ -20,6 +20,7 @@ "post": { "summary": "Créer une tâche d’agent (v1)", "deprecated": true, + "x-hidden": true, "description": "Obsolète : utilisez plutôt [v2 create agent job](/api/agent/v2/create-agent-job). Crée une nouvelle tâche d’agent capable de générer et de modifier de la documentation à partir des messages fournis et des informations de branche.", "parameters": [ { @@ -124,6 +125,7 @@ "get": { "summary": "Récupérer une tâche d’agent par ID (v1)", "deprecated": true, + "x-hidden": true, "description": "Obsolète : utilisez plutôt [v2 get agent job](/api/agent/v2/get-agent-job). Récupère les détails et le statut d’une tâche d’agent spécifique à partir de son ID.", "parameters": [ { @@ -250,6 +252,7 @@ "get": { "summary": "Récupérer toutes les tâches d’agent (v1)", "deprecated": true, + "x-hidden": true, "description": "Obsolète : utilisez plutôt [v2 get agent job](/api/agent/v2/get-agent-job). Récupère toutes les tâches d’agent pour le domain spécifié, y compris leur statut et leurs détails.", "parameters": [ { diff --git a/fr/api/agent/create-agent-job.mdx b/fr/api/agent/create-agent-job.mdx deleted file mode 100644 index 73a1cbcb1b..0000000000 --- a/fr/api/agent/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Créer une tâche d’agent (v1)" -openapi: /fr/admin-openapi.json POST /v1/agent/{projectId}/job -keywords: [ "tâche d'agent", "création", "automatisation", "automatiser" ] -tag: "deprecated" ---- - -Cet endpoint est obsolète. Utilisez plutôt l’endpoint [v2 create agent job](/fr/api/agent/v2/create-agent-job). - -Cet endpoint crée une tâche d’agent à partir des messages fournis et des informations de branche. La tâche s’exécute de manière asynchrone et renvoie une réponse en streaming contenant les détails d’exécution et les résultats. - -Si la branche n’existe pas, l’agent en crée une. Si des fichiers sont modifiés avec succès, une pull request (demande de fusion) est automatiquement créée à la fin de la tâche. - -
- ## Limites de débit -
- -L’API de l’agent est soumise aux limites suivantes : - -* 100 utilisations par projet Mintlify et par heure - -
- ## Utilisation recommandée -
- -Pour de meilleurs résultats, utilisez le [hook useChat d’ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) pour envoyer des requêtes et gérer les réponses. \ No newline at end of file diff --git a/fr/api/agent/get-agent-job.mdx b/fr/api/agent/get-agent-job.mdx deleted file mode 100644 index 9afd8ad7a8..0000000000 --- a/fr/api/agent/get-agent-job.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Obtenir une tâche d’agent (v1)" -openapi: /fr/admin-openapi.json GET /v1/agent/{projectId}/job/{id} -keywords: [ "tâche d’agent", "statut", "récupération", "détails" ] -tag: "deprecated" ---- - -Ce point de terminaison est obsolète. Utilisez plutôt le point de terminaison [v2 get agent job](/fr/api/agent/v2/get-agent-job). - -
- ## Utilisation -
- -Ce point de terminaison récupère les détails et l’état d’une tâche d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’une tâche d’agent créée précédemment. - -
- ## Détails du job -
- -La réponse inclut des informations telles que : - -* Statut d’exécution du job et état d’achèvement -* Informations sur la branche et détails du pull request (demande de fusion) -* metadata de session et horodatages \ No newline at end of file diff --git a/fr/api/agent/get-all-jobs.mdx b/fr/api/agent/get-all-jobs.mdx deleted file mode 100644 index 6dd9a77fdb..0000000000 --- a/fr/api/agent/get-all-jobs.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Lister les jobs d’agent (v1)" -openapi: /fr/admin-openapi.json GET /v1/agent/{projectId}/jobs -keywords: [ "job d’agent", "liste", "monitoring" ] -tag: "deprecated" ---- - -Ce point de terminaison est obsolète. Utilisez plutôt le point de terminaison [v2 obtenir un job d’agent](/fr/api/agent/v2/get-agent-job). - -
- ## Utilisation -
- -Cet endpoint récupère tous les jobs d’agent pour le domain spécifié, offrant une vue d’ensemble de toutes les activités des agents et de leur état actuel. C’est utile pour surveiller et gérer plusieurs jobs d’agent simultanés ou historiques. - -
- ## Réponse -
- -Utilisez ce point de terminaison pour obtenir une vue d’ensemble de toutes les sessions d’agent précédentes. \ No newline at end of file diff --git a/fr/api/agent/v2/create-agent-job.mdx b/fr/api/agent/v2/create-agent-job.mdx deleted file mode 100644 index 9ba5b94787..0000000000 --- a/fr/api/agent/v2/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Créer une tâche d'agent" -openapi: /fr/admin-openapi.json POST /v2/agent/{projectId}/job -keywords: [ "tâche d'agent", "créer", "automatisation", "automatiser" ] ---- - -Ce point de terminaison crée une tâche d'agent en arrière-plan. La tâche s'exécute de manière asynchrone — utilisez le point de terminaison [récupérer une tâche d'agent](/fr/api/agent/v2/get-agent-job) pour vérifier régulièrement les mises à jour de statut. - -Si l'agent modifie les fichiers avec succès, une pull request (demande de fusion) est automatiquement créée et le champ `prLink` est renseigné dans la réponse de la tâche. - -
- ## Limites d’utilisation -
- -* 100 utilisations par projet Mintlify et par heure - -
- ## Utilisation -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Add a quickstart guide for the Python SDK"}' -``` diff --git a/fr/api/agent/v2/get-agent-job.mdx b/fr/api/agent/v2/get-agent-job.mdx deleted file mode 100644 index e419a8ad5c..0000000000 --- a/fr/api/agent/v2/get-agent-job.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Récupérer une tâche d’agent" -openapi: /fr/admin-openapi.json GET /v2/agent/{projectId}/job/{id} -keywords: [ "tâche d’agent", "statut", "récupérer", "détails", "interroger" ] ---- - -Interrogez régulièrement ce point de terminaison pour suivre la progression d’une tâche d’agent. Le champ `status` passe de `active` à `completed` ou `failed`. - -Une fois que l’agent a créé une pull request (demande de fusion), le champ `prLink` est renseigné. \ No newline at end of file diff --git a/fr/api/agent/v2/send-message.mdx b/fr/api/agent/v2/send-message.mdx deleted file mode 100644 index f7bab3b2ed..0000000000 --- a/fr/api/agent/v2/send-message.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Envoyer un message de suivi" -openapi: /fr/admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message -keywords: [ "tâche d’agent", "message", "suivi", "envoyer" ] ---- - -Envoyez une instruction de suivi à une tâche d’agent existante. Le message est traité de façon asynchrone — interrogez le point de terminaison [récupérer la tâche d’agent](/fr/api/agent/v2/get-agent-job) pour suivre sa progression. - -
- ## Limites de débit -
- -* 100 utilisations par projet Mintlify par heure - -
- ## Utilisation -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Also add error handling examples to the quickstart guide"}' -``` diff --git a/fr/api/analytics/assistant-caller-stats.mdx b/fr/api/analytics/assistant-caller-stats.mdx deleted file mode 100644 index 5c35bdd6c8..0000000000 --- a/fr/api/analytics/assistant-caller-stats.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Récupérer les statistiques d'appels de l'Assistant" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats -keywords: ["analytics", "assistant", "caller", "stats", "export"] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour voir comment les requêtes de l'Assistant sont réparties entre les différents types d'appelants. La réponse décompose le total des requêtes en : - -- **web** : Requêtes provenant du site de documentation -- **api** : Requêtes provenant d'appels API directs -- **other** : Requêtes provenant d'autres sources (par exemple, intégrations, SDKs) -- **total** : Somme de tous les types de requêtes - -
- ## Filtrage -
- -Filtrez par plage de dates à l'aide des paramètres `dateFrom` et `dateTo`. diff --git a/fr/api/analytics/assistant-conversations.mdx b/fr/api/analytics/assistant-conversations.mdx deleted file mode 100644 index 08658ec412..0000000000 --- a/fr/api/analytics/assistant-conversations.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Récupérer les conversations de l'Assistant" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/assistant -keywords: [ "Analytics", "Assistant", "conversations", "export", "AI" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter l’historique des conversations de l’Assistant IA à partir de votre documentation. Chaque conversation inclut la requête de l’utilisateur, la réponse de l’Assistant IA, les sources citées, le statut de résolution et la catégorie de la requête. - -Parcourez les résultats à l’aide du paramètre `cursor` renvoyé dans la réponse. Continuez à récupérer les données tant que `hasMore` vaut `true`. - -
- ## Filtrage -
- -Filtrez les conversations par plage de dates à l'aide des paramètres `dateFrom` et `dateTo`. - -
- ## Données de conversation -
- -Chaque conversation comprend : - -- **query** : la question de l’utilisateur -- **response** : la réponse de l’Assistant -- **sources** : les pages référencées dans la réponse, avec leur title et leur URL -- **resolutionStatus** : indique si l’Assistant a répondu correctement à la question. La valeur est `answered` ou `unanswered`. Utilisez ce champ pour suivre et analyser les lacunes de la documentation mises en évidence par les questions des utilisateurs auxquelles l’Assistant n’a pas pu répondre. -- **queryCategory** : la classification du type de requête (si disponible) \ No newline at end of file diff --git a/fr/api/analytics/feedback-by-page.mdx b/fr/api/analytics/feedback-by-page.mdx deleted file mode 100644 index 48d5192cfb..0000000000 --- a/fr/api/analytics/feedback-by-page.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Obtenir les retours par page" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page -keywords: [ "analytics", "feedback", "export", "par page", "agrégé" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter les retours utilisateurs agrégés par chemin de page de documentation. Chaque entrée affiche le nombre total de retours pour une page, ventilé par type. - -
- ## Filtrage -
- -Filtrez les feedbacks par : - -- **Plage de dates** : utilisez `dateFrom` et `dateTo` pour limiter les résultats à une période donnée -- **Source** : filtrez par type de feedback, `code_snippet`, `contextual` ou `agent` -- **Statut** : filtrez par des valeurs de statut comme `pending`, `in_progress`, `resolved` ou `dismissed` diff --git a/fr/api/analytics/feedback.mdx b/fr/api/analytics/feedback.mdx deleted file mode 100644 index 88bfc49664..0000000000 --- a/fr/api/analytics/feedback.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Obtenir des retours" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/feedback -keywords: [ "analytics", "feedback", "export", "feedback utilisateur" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter les retours utilisateurs collectés à partir de votre documentation. Les retours incluent les commentaires contextuels issus des évaluations de pages, les retours sur les extraits de code et les retours des agents. - -Parcourez les résultats à l’aide du paramètre `cursor` renvoyé dans la réponse. Continuez à effectuer des requêtes tant que `hasMore` vaut `true`. - -
- ## Filtrage -
- -Filtrez les feedbacks par : - -- **Plage de dates** : utilisez `dateFrom` et `dateTo` pour limiter les résultats à une période donnée -- **Source** : filtrez par type de feedback, `code_snippet`, `contextual` ou `agent` -- **Statut** : filtrez par des valeurs de statut comme `pending`, `in_progress`, `resolved` ou `dismissed` - -
- ## Types de réponse -
- -La réponse contient différents types de commentaires en fonction de la source : - -- **Commentaire contextuel** : inclut le booléen `helpful` et éventuellement l’adresse e-mail `contact` -- **Commentaire sur extrait de code** : inclut les champs `code`, `filename` et `lang` -- **Retour d'agent** : inclut un `comment` avec le texte du retour de l'agent et le `path` de la page concernée diff --git a/fr/api/analytics/searches.mdx b/fr/api/analytics/searches.mdx deleted file mode 100644 index d3df0c56a2..0000000000 --- a/fr/api/analytics/searches.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtenir les requêtes de recherche" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/searches -keywords: [ "analytics", "recherche", "export", "requêtes", "termes de recherche" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter les analyses de recherche de la documentation. Les résultats sont triés par nombre de résultats décroissant, montrant les termes que vos utilisateurs recherchent le plus. - -Parcourez les résultats à l'aide du paramètre `nextCursor` renvoyé dans la réponse. Continuez à effectuer des requêtes tant que `nextCursor` n'est pas nul. - -
- ## Filtrage -
- -Filtrez les données de recherche par plage de dates à l'aide des paramètres `dateFrom` et `dateTo`. diff --git a/fr/api/analytics/views.mdx b/fr/api/analytics/views.mdx deleted file mode 100644 index f4289dff52..0000000000 --- a/fr/api/analytics/views.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtenir les vues de page" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/views -keywords: [ "analytics", "vues", "vues de page", "trafic", "export" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter les analyses de vues de page. Les résultats incluent les totaux du site et les détails par page, répartis entre le trafic humain et celui de l'IA. - -Parcourez les résultats à l'aide de la pagination par décalage. Incrémentez `offset` de `limit` tant que `hasMore` est `true`. - -
- ## Filtrage -
- -Filtrez les données de vues par plage de dates à l'aide des paramètres `dateFrom` et `dateTo`. diff --git a/fr/api/analytics/visitors.mdx b/fr/api/analytics/visitors.mdx deleted file mode 100644 index e6e6be05f9..0000000000 --- a/fr/api/analytics/visitors.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Obtenir les visiteurs uniques" -openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/visitors -keywords: [ "analytics", "visiteurs", "visiteurs uniques", "trafic", "export" ] ---- - -
- ## Utilisation -
- -Utilisez cet endpoint pour exporter les analyses de visiteurs uniques. Les résultats incluent les totaux du site et les détails par page, répartis entre le trafic humain et celui de l'IA. Le champ `total` est dédupliqué entre le trafic humain et celui de l'IA. - -Parcourez les résultats à l'aide de la pagination par décalage. Incrémentez `offset` de `limit` tant que `hasMore` est `true`. - -
- ## Filtrage -
- -Filtrez les données de visiteurs par plage de dates à l'aide des paramètres `dateFrom` et `dateTo`. diff --git a/fr/api/assistant/create-assistant-message-v2.mdx b/fr/api/assistant/create-assistant-message-v2.mdx deleted file mode 100644 index bbe918cd38..0000000000 --- a/fr/api/assistant/create-assistant-message-v2.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Créer un message de l'Assistant" -openapi: /fr/discovery-openapi.json POST /v2/assistant/{domain}/message -keywords: - [ - "assistant message", - "embed", - "chat", - "intégrer", - "v2", - "ai sdk v5", - "ai sdk v6" - ] ---- - - - L'endpoint assistant message v2 est compatible avec **AI SDK v5+**. Si vous utilisez l'AI SDK v4, utilisez plutôt l'[endpoint assistant message v1](/fr/api/assistant/create-assistant-message). - - -
- ## Intégration avec `useChat` -
- -Le hook `useChat` de l'AI SDK de Vercel est la méthode recommandée pour intégrer l'API Assistant dans votre application. - - - - ```bash - npm i ai@^6 @ai-sdk/react - ``` - - - - ```tsx - import { useState } from "react"; - import { useChat } from "@ai-sdk/react"; - import { DefaultChatTransport } from "ai"; - - function MyComponent({ domain }) { - const [input, setInput] = useState(""); - - const { messages, sendMessage } = useChat({ - transport: new DefaultChatTransport({ - api: `https://api.mintlify.com/discovery/v2/assistant/${domain}/message`, - headers: { - Authorization: `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: "anonymous", - retrievalPageSize: 5, - context: [ - { - type: "code", - value: 'const example = "code snippet";', - elementId: "code-block-1", - }, - ], - }, - }), - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === "user" ? "User: " : "Assistant: "} - {message.parts - .filter((part) => part.type === "text") - .map((part) => part.text) - .join("")} -
- ))} -
{ - e.preventDefault(); - if (input.trim()) { - sendMessage({ text: input }); - setInput(""); - } - }} - > - setInput(e.target.value)} /> - -
-
- ); - } - ``` - - **Configuration requise :** - - * `transport` - Utilisez `DefaultChatTransport` pour configurer la connexion à l'API. - * `body.fp` - Identifiant d’empreinte (utilisez `'anonymous'` ou un identifiant utilisateur unique). - * `body.retrievalPageSize` - Nombre de résultats de recherche à utiliser (recommandé : 5). - - **Configuration optionnelle :** - - * `body.context` - Tableau d’informations contextuelles à fournir à l’Assistant. Chaque objet de contexte contient : - * `type` - Soit `'code'` soit `'textSelection'`. - * `value` - Le morceau de code ou le contenu textuel sélectionné. - * `path` (optionnel) - Chemin vers le fichier source ou la page. - * `elementId` (optionnel) - Identifiant de l’élément d’interface contenant le contexte. - * `body.currentPath` - Chemin de la page que l’utilisateur est en train de consulter. Lorsqu’il est fourni, l’Assistant utilise ce contexte pour fournir des réponses plus pertinentes. Longueur maximale : 200 caractères. - - - -Voir [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) et [Transport](https://ai-sdk.dev/docs/ai-sdk-ui/transport) dans la documentation de l'AI SDK pour plus de détails. - -
- ## Limites de débit -
- -L'API Assistant est soumise aux limites suivantes : - -* 10 000 requêtes par organisation Mintlify et par heure -* 10 000 requêtes par IP et par jour \ No newline at end of file diff --git a/fr/api/assistant/create-assistant-message.mdx b/fr/api/assistant/create-assistant-message.mdx deleted file mode 100644 index cc4d7a330e..0000000000 --- a/fr/api/assistant/create-assistant-message.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "Créer un message de l’Assistant (v1)" -openapi: /fr/discovery-openapi.json POST /v1/assistant/{domain}/message -tag: "Obsolète" -keywords: [ "message de l’Assistant", "intégration", "chat", "intégrer", "ai sdk v4" ] ---- - -Obsolète - - - Le point de terminaison assistant message v1 est compatible avec **AI SDK v4**. Si vous utilisez AI SDK v5 ou une version ultérieure, utilisez plutôt le [point de terminaison assistant message v2](/fr/api/assistant/create-assistant-message-v2). - - -
- ## Intégration avec `useChat` -
- -Le hook `useChat` du SDK AI de Vercel est la méthode recommandée pour intégrer l’API de l’Assistant à votre application. - - - - ```bash - npm i ai@^4.1.15 - ``` - - - - ```tsx - import { useChat } from 'ai/react'; - - function MyComponent({ domain }) { - const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({ - api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`, - headers: { - 'Authorization': `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: 'anonymous', - retrievalPageSize: 5, - context: [ - { - type: 'code', - value: 'const example = "code snippet";', - elementId: 'code-block-1', - }, - ], - }, - streamProtocol: 'data', - sendExtraMessageFields: true, - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === 'user' ? 'Utilisateur : ' : 'Assistant : '} - {message.content} -
- ))} -
- - -
-
- ); - } - ``` - - **Configuration requise pour Mintlify :** - - * `streamProtocol: 'data'` - Requis pour les réponses en streaming. - * `sendExtraMessageFields: true` - Requis pour envoyer les métadonnées des messages. - * `body.fp` - Identifiant d’empreinte (utilisez 'anonymous' ou un identifiant utilisateur). - * `body.retrievalPageSize` - Nombre de résultats de recherche à utiliser (recommandé : 5). - - **Configuration optionnelle :** - - * `body.context` - Tableau d’informations contextuelles à fournir à l’Assistant. Chaque objet de contexte contient : - * `type` - Soit `'code'` soit `'textSelection'`. - * `value` - L’extrait de code ou le texte sélectionné. - * `elementId` (optionnel) - Identifiant de l’élément d’interface contenant le contexte. - * `body.currentPath` - Le chemin de la page actuellement consultée par l’utilisateur. Lorsqu’il est fourni, l’Assistant utilise ce contexte pour donner des réponses plus pertinentes. Longueur maximale : 200 caractères. - - - -Consultez [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) dans la documentation du SDK AI pour en savoir plus. - -
- ## Limites de débit -
- -L’API de l’Assistant applique les limites suivantes : - -* 10 000 requêtes par organisation Mintlify et par heure -* 10 000 requêtes par adresse IP et par jour \ No newline at end of file diff --git a/fr/api/assistant/get-page-content.mdx b/fr/api/assistant/get-page-content.mdx deleted file mode 100644 index 254cf03d5e..0000000000 --- a/fr/api/assistant/get-page-content.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Obtenir le contenu de la page" -openapi: "/fr/discovery-openapi.json POST /v1/page/{domain}" -keywords: [ "page", "contenu", "récupérer" ] ---- - -
-## Limites de débit -
- -- 10 000 requêtes par organisation Mintlify par heure diff --git a/fr/api/assistant/search.mdx b/fr/api/assistant/search.mdx deleted file mode 100644 index a51024b367..0000000000 --- a/fr/api/assistant/search.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Rechercher dans la documentation" -openapi: "/fr/discovery-openapi.json POST /v1/search/{domain}" -keywords: [ "recherche", "requête" ] ---- - -
-## Limites de débit -
- -- 10 000 requêtes par organisation Mintlify par heure \ No newline at end of file diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index 38267edcf5..afd901878d 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -11,29 +11,29 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir ## Endpoints -* [Trigger update](/fr/api/update/trigger): Déclenchez une mise à jour de votre site quand vous le souhaitez. -* [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation. -* [Trigger preview deployment](/fr/api/preview/trigger): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. -* [Create agent job](/fr/api/agent/v2/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation. -* [Get agent job](/fr/api/agent/v2/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique. -* [Send follow-up message](/fr/api/agent/v2/send-message): Envoyez un message de suivi à une tâche d'agent existante. -* [Create assistant message](/fr/api/assistant/create-assistant-message-v2): Intégrez l'Assistant, entraîné sur votre documentation, dans n'importe quelle application de votre choix. -* [Search documentation](/fr/api/assistant/search): Effectuez une recherche dans votre documentation. -* [Get page content](/fr/api/assistant/get-page-content): Récupérez le contenu textuel complet d'une page de documentation. -* [Get user feedback](/fr/api/analytics/feedback): Exportez les retours utilisateurs issus de votre documentation. -* [Get assistant conversations](/fr/api/analytics/assistant-conversations): Exportez l'historique des conversations de l'Assistant IA. -* [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats): Récupérez une ventilation du nombre de requêtes de l'assistant par type d'appelant. +- [Trigger update](/fr/api/admin/trigger-update): Déclenchez une mise à jour de votre site quand vous le souhaitez. +- [Get update status](/fr/api/admin/get-update-status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation. +- [Trigger preview deployment](/fr/api/admin/trigger-preview-deployment): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. +- [Create agent job](/fr/api/agent/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation. +- [Get agent job](/fr/api/agent/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique. +- [Send follow-up message](/fr/api/agent/send-follow-up-message): Envoyez un message de suivi à une tâche d'agent existante. +- [Create assistant message](/fr/api/assistant/create-assistant-message): Intégrez l'Assistant, entraîné sur votre documentation, dans n'importe quelle application de votre choix. +- [Search documentation](/fr/api/assistant/search-documentation): Effectuez une recherche dans votre documentation. +- [Get page content](/fr/api/assistant/get-page-content): Récupérez le contenu textuel complet d'une page de documentation. +- [Get user feedback](/fr/api/analytics/get-feedback): Exportez les retours utilisateurs issus de votre documentation. +- [Get assistant conversations](/fr/api/analytics/get-assistant-conversations): Exportez l'historique des conversations de l'Assistant IA. +- [Get assistant caller stats](/fr/api/analytics/get-assistant-caller-stats): Récupérez une ventilation du nombre de requêtes de l'assistant par type d'appelant.
### Cas d'utilisation courants
-* **Déploiements automatisés** : Déclenchez les mises à jour du site à intervalles réguliers ou lorsqu'un événement se produit avec [Trigger update](/fr/api/update/trigger) et [Get update status](/fr/api/update/status). -* **Intégration CI/CD** : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec [Trigger update](/fr/api/update/trigger). -* **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/preview/trigger). -* **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content). -* **Édition automatisée** : Utilisez des jobs d'agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), et [Send follow-up message](/fr/api/agent/v2/send-message). -* **Export Analytics** : Exportez les retours utilisateurs, les conversations de l'Assistant et les données de visiteurs pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats). +- **Déploiements automatisés** : Déclenchez les mises à jour du site à intervalles réguliers ou lorsqu'un événement se produit avec [Trigger update](/fr/api/admin/trigger-update) et [Get update status](/fr/api/admin/get-update-status). +- **Intégration CI/CD** : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec [Trigger update](/fr/api/admin/trigger-update). +- **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/admin/trigger-preview-deployment). +- **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message), [Search documentation](/fr/api/assistant/search-documentation) et [Get page content](/fr/api/assistant/get-page-content). +- **Édition automatisée** : Utilisez des jobs d'agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api/agent/create-agent-job), [Get agent job](/fr/api/agent/get-agent-job), et [Send follow-up message](/fr/api/agent/send-follow-up-message). +- **Export Analytics** : Exportez les retours utilisateurs, les conversations de l'Assistant et les données de visiteurs pour une analyse externe avec [Get user feedback](/fr/api/analytics/get-feedback), [Get assistant conversations](/fr/api/analytics/get-assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/get-assistant-caller-stats).
## Authentification @@ -47,7 +47,7 @@ Vous pouvez créer jusqu'à 10 clés d'API par heure et par organisation. ### Clé d'API administrateur
-Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats). +Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/admin/trigger-update), [Get update status](/fr/api/admin/get-update-status), [Trigger preview deployment](/fr/api/admin/trigger-preview-deployment), [Create agent job](/fr/api/agent/create-agent-job), [Get agent job](/fr/api/agent/get-agent-job), [Send follow-up message](/fr/api/agent/send-follow-up-message), [Get user feedback](/fr/api/analytics/get-feedback), [Get assistant conversations](/fr/api/analytics/get-assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/get-assistant-caller-stats). Les clés d'API administrateur commencent par le préfixe `mint_`. @@ -57,7 +57,7 @@ La clé d'API administrateur est un secret côté serveur. Ne l'exposez pas dans ### Clé d'API de l'Assistant -Utilisez la clé d'API de l'Assistant pour authentifier les requêtes vers les points de terminaison [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content). +Utilisez la clé d'API de l'Assistant pour authentifier les requêtes vers les points de terminaison [Create assistant message](/fr/api/assistant/create-assistant-message), [Search documentation](/fr/api/assistant/search-documentation) et [Get page content](/fr/api/assistant/get-page-content). Les clés d'API de l'Assistant commencent par le préfixe `mint_dsc_`. @@ -65,4 +65,4 @@ La clé d'API de l'Assistant est un jeton public qui peut être référencé dan Les appels utilisant le token de l'API de l'Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d'Assistant, soit en engendrant des dépassements. - + \ No newline at end of file diff --git a/fr/api/preview/trigger.mdx b/fr/api/preview/trigger.mdx deleted file mode 100644 index 99c9264280..0000000000 --- a/fr/api/preview/trigger.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Déclencher un déploiement de prévisualisation" -openapi: "/fr/openapi.json POST /project/preview/{projectId}" -keywords: ["preview", "preview deployment", "branch preview", "staging"] ---- - -Utilisez cet endpoint pour créer ou mettre à jour de manière programmatique un déploiement de prévisualisation pour une branche Git. Si une prévisualisation existe déjà pour la branche spécifiée, l'endpoint déclenche un redéploiement au lieu de créer un doublon. - -La réponse inclut un `statusId` que vous pouvez transmettre à [Get deployment status](/fr/api/update/status) pour suivre la progression du déploiement. - -
- ## Cas d'utilisation -
- -- **Pipelines CI/CD** : Créez automatiquement des déploiements de prévisualisation lorsque des pull requests sont ouvertes ou mises à jour. -- **Prévisualisations planifiées** : Générez des prévisualisations de branches de fonctionnalités de longue durée selon un calendrier. -- **Outillage personnalisé** : Intégrez la création de prévisualisations dans des workflows internes ou des bots Slack. - -
- ## Limites de débit -
- -Cet endpoint autorise jusqu'à 5 requêtes par minute et par organisation. diff --git a/fr/api/update/status.mdx b/fr/api/update/status.mdx deleted file mode 100644 index 30dcdcce0a..0000000000 --- a/fr/api/update/status.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Obtenir le statut de déploiement" -openapi: "/fr/openapi.json GET /project/update-status/{statusId}" -keywords: [ "mettre à jour l’état", "état de déploiement", "vérifier l’état" ] ---- \ No newline at end of file diff --git a/fr/api/update/trigger.mdx b/fr/api/update/trigger.mdx deleted file mode 100644 index 80e35a435e..0000000000 --- a/fr/api/update/trigger.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Déclencher un déploiement" -openapi: "/fr/openapi.json POST /project/update/{projectId}" -keywords: [ "déclenchement", "mise à jour", "déploiement", "programmatiquement" ] ---- \ No newline at end of file diff --git a/fr/discovery-openapi.json b/fr/discovery-openapi.json index ea1493bc14..95f3af1f9b 100644 --- a/fr/discovery-openapi.json +++ b/fr/discovery-openapi.json @@ -19,6 +19,8 @@ "/v1/assistant/{domain}/message": { "post": { "summary": "Message de l’Assistant v1", + "deprecated": true, + "x-hidden": true, "description": "Génère un message de réponse de l’Assistant pour le domain spécifié. Compatible avec l’AI SDK v4.", "parameters": [ { diff --git a/openapi.json b/openapi.json index 6101b08d45..292ed6bc0c 100644 --- a/openapi.json +++ b/openapi.json @@ -253,7 +253,7 @@ "properties": { "statusId": { "type": "string", - "description": "The status ID for tracking the preview deployment. Use this with the [Get deployment status](/api/update/status) endpoint." + "description": "The status ID for tracking the preview deployment. Use this with the [Get deployment status](/api/admin/get-update-status) endpoint." }, "previewUrl": { "type": "string", diff --git a/zh.json b/zh.json index 3ff13485a6..1beae591d3 100644 --- a/zh.json +++ b/zh.json @@ -338,38 +338,22 @@ { "group": "管理", "icon": "activity", - "pages": [ - "zh/api/update/trigger", - "zh/api/update/status", - "zh/api/preview/trigger" - ] + "openapi": "zh/openapi.json" }, { "group": "代理", "icon": "pen-line", - "pages": [ - "zh/api/agent/v2/create-agent-job", - "zh/api/agent/v2/get-agent-job", - "zh/api/agent/v2/send-message" - ] + "openapi": "zh/admin-openapi.json" }, { "group": "AI 助手", "icon": "bot-message-square", - "pages": [ - "zh/api/assistant/create-assistant-message-v2", - "zh/api/assistant/search", - "zh/api/assistant/get-page-content" - ] + "openapi": "zh/discovery-openapi.json" }, { "group": "数据分析", "icon": "chart-line", - "pages": [ - "zh/api/analytics/feedback", - "zh/api/analytics/assistant-conversations", - "zh/api/analytics/assistant-caller-stats" - ] + "openapi": "zh/analytics.openapi.json" } ] }, diff --git a/zh/admin-openapi.json b/zh/admin-openapi.json index ad72f5e93c..bf347c0a61 100644 --- a/zh/admin-openapi.json +++ b/zh/admin-openapi.json @@ -124,6 +124,7 @@ "get": { "summary": "按 ID 获取代理任务（v1）", "deprecated": true, + "x-hidden": true, "description": "已废弃：请改用 [v2 get agent job](/api/agent/v2/get-agent-job)。按 ID 检索特定代理任务的详细信息和状态。", "parameters": [ { @@ -250,6 +251,7 @@ "get": { "summary": "获取所有代理任务（v1）", "deprecated": true, + "x-hidden": true, "description": "已废弃：请改用 [v2 get agent job](/api/agent/v2/get-agent-job)。检索指定 domain 的所有代理任务，包括其状态和详细信息。", "parameters": [ { diff --git a/zh/api/agent/create-agent-job.mdx b/zh/api/agent/create-agent-job.mdx deleted file mode 100644 index 168c79415d..0000000000 --- a/zh/api/agent/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "创建代理任务 (v1)" -openapi: /zh/admin-openapi.json POST /v1/agent/{projectId}/job -keywords: [ "agent job", "create", "automation", "automate" ] -tag: "deprecated" ---- - -此端点已废弃。请改用 [v2 创建代理任务](/zh/api/agent/v2/create-agent-job) 端点。 - -此端点会根据提供的消息和分支信息创建一个代理任务。该任务异步执行，并以流式方式返回包含执行详情与结果的响应。 - -如果分支不存在，代理会自动创建该分支。若文件编辑成功，任务结束时会自动创建一个拉取请求。 - -
- ## 速率限制 -
- -代理 API 的限制如下： - -* 每个 Mintlify 项目每小时最多可调用 100 次 - -
- ## 建议用法 -
- -为获得最佳效果，请使用 [ai-sdk 的 useChat 钩子](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) 来发送请求并处理响应。 \ No newline at end of file diff --git a/zh/api/agent/get-agent-job.mdx b/zh/api/agent/get-agent-job.mdx deleted file mode 100644 index bf754e04dd..0000000000 --- a/zh/api/agent/get-agent-job.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "获取代理任务（v1）" -openapi: /zh/admin-openapi.json GET /v1/agent/{projectId}/job/{id} -keywords: [ "代理任务", "状态", "获取", "详情" ] -tag: "deprecated" ---- - -此端点已废弃。请改用 [v2 获取代理任务](/zh/api/agent/v2/get-agent-job) 端点。 - -
- ## 用法 -
- -此端点通过代理任务的唯一标识符获取该任务的详细信息和状态。可用于查看先前创建的代理任务的进度、状态和结果。 - -
- ## 作业详情 -
- -响应包含以下信息： - -* 作业执行状态与完成情况 -* branch 信息和拉取请求 (PR；亦称“合并请求”/Merge Request) 详情 -* 会话 metadata 与时间戳 \ No newline at end of file diff --git a/zh/api/agent/get-all-jobs.mdx b/zh/api/agent/get-all-jobs.mdx deleted file mode 100644 index cc03532328..0000000000 --- a/zh/api/agent/get-all-jobs.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "列出代理任务 (v1)" -openapi: /zh/admin-openapi.json GET /v1/agent/{projectId}/jobs -keywords: [ "代理任务", "列表", "监控" ] -tag: "deprecated" ---- - -此端点已废弃。请改用 [v2 获取代理任务](/zh/api/agent/v2/get-agent-job) 端点。 - -
- ## 用法 -
- -该端点会检索指定 domain 的所有代理任务，概览所有代理活动及其当前状态。适用于监控和管理多个并发或历史代理任务。 - -
- ## 响应 -
- -使用此端点可获取所有历史代理会话的完整概览。 \ No newline at end of file diff --git a/zh/api/agent/v2/create-agent-job.mdx b/zh/api/agent/v2/create-agent-job.mdx deleted file mode 100644 index 727a31bfe5..0000000000 --- a/zh/api/agent/v2/create-agent-job.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "创建 Agent 作业" -openapi: /zh/admin-openapi.json POST /v2/agent/{projectId}/job -keywords: [ "Agent 作业", "创建", "自动化", "自动执行" ] ---- - -此端点用于创建后台 Agent 作业。该作业会异步运行——请使用 [获取 Agent 作业](/zh/api/agent/v2/get-agent-job) 端点轮询状态更新。 - -如果 Agent 成功编辑文件，则会自动创建拉取请求 (PR；亦称“合并请求”/Merge Request) ，并在作业响应中填充 `prLink` 字段。 - -
- ## 速率限制 -
- -* 每个 Mintlify 项目每小时可使用 100 次 - -
- ## 用法 -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Add a quickstart guide for the Python SDK"}' -``` diff --git a/zh/api/agent/v2/get-agent-job.mdx b/zh/api/agent/v2/get-agent-job.mdx deleted file mode 100644 index 6783923ab5..0000000000 --- a/zh/api/agent/v2/get-agent-job.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "获取代理任务" -openapi: /zh/admin-openapi.json GET /v2/agent/{projectId}/job/{id} -keywords: [ "代理任务", "状态", "获取", "详细信息", "轮询" ] ---- - -轮询此端点以跟踪代理任务的进度。`status` 字段会从 `active` 变为 `completed` 或 `failed`。 - -代理创建拉取请求 (PR；亦称“合并请求”/Merge Request) 后，`prLink` 字段会被填入。 \ No newline at end of file diff --git a/zh/api/agent/v2/send-message.mdx b/zh/api/agent/v2/send-message.mdx deleted file mode 100644 index 4e9b69afed..0000000000 --- a/zh/api/agent/v2/send-message.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "发送后续消息" -openapi: /zh/admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message -keywords: [ "代理任务", "消息", "后续", "发送" ] ---- - -向现有代理任务发送后续指令。该消息会异步处理——请轮询 [获取代理任务](/zh/api/agent/v2/get-agent-job) 端点以跟踪进度。 - -
- ## 速率限制 -
- -* 每个 Mintlify 项目每小时最多可使用 100 次 - -
- ## 用法 -
- -```bash -curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{"prompt": "Also add error handling examples to the quickstart guide"}' -``` diff --git a/zh/api/analytics/assistant-caller-stats.mdx b/zh/api/analytics/assistant-caller-stats.mdx deleted file mode 100644 index 7972618dd9..0000000000 --- a/zh/api/analytics/assistant-caller-stats.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "获取 AI 助手调用方统计" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats -keywords: ["analytics", "assistant", "caller", "stats", "export"] ---- - -
- ## 使用方法 -
- -使用此端点查看助手查询在不同调用方类型之间的分布情况。响应将总查询次数细分为： - -- **web**: 来自文档站点的查询 -- **api**: 来自直接 API 调用的查询 -- **other**: 来自其他来源的查询（例如集成、SDK） -- **total**: 所有查询类型的总和 - -
- ## 筛选 -
- -使用 `dateFrom` 和 `dateTo` 参数按日期范围筛选。 diff --git a/zh/api/analytics/assistant-conversations.mdx b/zh/api/analytics/assistant-conversations.mdx deleted file mode 100644 index 2bd5808dbe..0000000000 --- a/zh/api/analytics/assistant-conversations.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "获取 AI 助手会话记录" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/assistant -keywords: [ "analytics", "assistant", "conversations", "export", "AI" ] ---- - -
- ## 使用方法 -
- -使用此端点从你的文档中导出 AI 助手的会话历史。每个会话都包括用户查询、助手回复、引用的来源、解决状态以及查询类别。 - -使用响应中返回的 `cursor` 参数对结果进行分页。当 `hasMore` 为 `true` 时继续获取。 - -
- ## 筛选 -
- -使用 `dateFrom` 和 `dateTo` 参数按日期范围过滤会话。 - -
- ## 会话数据 -
- -每个会话包含： - -- **query**: 用户的问题 -- **response**: AI 助手的回答 -- **sources**: 回答中引用的页面，包括标题和 URL -- **resolutionStatus**: AI 助手是否成功回答了问题。值为 `answered` 或 `unanswered`。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。 -- **queryCategory**: query 的类型分类（如果可用） \ No newline at end of file diff --git a/zh/api/analytics/feedback-by-page.mdx b/zh/api/analytics/feedback-by-page.mdx deleted file mode 100644 index ac16df3dcd..0000000000 --- a/zh/api/analytics/feedback-by-page.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "按页面获取反馈" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page -keywords: ["analytics", "反馈", "导出", "按页面", "汇总"] ---- - -
- ## 使用方法 -
- -使用此端点导出按文档页面路径汇总的用户反馈。每条记录显示一个页面的反馈总数，并按类型细分。 - -
- ## 筛选 -
- -可以按以下维度筛选反馈： - -- **日期范围**：使用 `dateFrom` 和 `dateTo` 将结果限定在特定时间段内 -- **来源**：按 `code_snippet`、`contextual` 或 `agent` 等反馈来源类型进行筛选 -- **状态**：按状态值进行筛选，例如 `pending`、`in_progress`、`resolved` 或 `dismissed` diff --git a/zh/api/analytics/feedback.mdx b/zh/api/analytics/feedback.mdx deleted file mode 100644 index 57b035583b..0000000000 --- a/zh/api/analytics/feedback.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "获取反馈" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/feedback -keywords: ["Analytics", "反馈", "导出", "用户反馈"] ---- - -
- ## 用法 -
- -使用此端点导出从文档中收集的用户反馈。反馈包括来自页面评分的上下文反馈、代码片段反馈和 Agent 反馈。 - -使用响应中返回的 `cursor` 参数对结果进行分页。当 `hasMore` 为 `true` 时继续获取数据。 - -
- ## 筛选 -
- -可以按以下维度筛选反馈： - -- **日期范围**：使用 `dateFrom` 和 `dateTo` 将结果限定在特定时间段内 -- **来源**：按 `code_snippet`、`contextual` 或 `agent` 等反馈来源类型进行筛选 -- **状态**：按状态值进行筛选，例如 `pending`、`in_progress`、`resolved` 或 `dismissed` - -
- ## 响应类型 -
- -响应会根据不同的 source 包含不同类型的反馈： - -- **上下文反馈**：包含 `helpful` 布尔值和可选的 `contact` 邮箱 -- **代码片段反馈**：包含 `code`、`filename` 和 `lang` 字段 -- **Agent 反馈**：包含 Agent 提交的反馈文本 `comment` 和相关页面的 `path` \ No newline at end of file diff --git a/zh/api/analytics/searches.mdx b/zh/api/analytics/searches.mdx deleted file mode 100644 index f90b6fb9bc..0000000000 --- a/zh/api/analytics/searches.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "获取搜索查询" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/searches -keywords: ["analytics", "搜索", "导出", "查询", "搜索词"] ---- - -
- ## 使用方法 -
- -使用此端点导出文档搜索分析数据。结果按命中次数从高到低排序，显示用户最常搜索的词语。 - -使用响应中返回的 `nextCursor` 参数对结果进行分页。当 `nextCursor` 不为 null 时继续获取数据。 - -
- ## 筛选 -
- -使用 `dateFrom` 和 `dateTo` 参数按日期范围过滤搜索数据。 diff --git a/zh/api/analytics/views.mdx b/zh/api/analytics/views.mdx deleted file mode 100644 index 0d3f2e092a..0000000000 --- a/zh/api/analytics/views.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "获取页面浏览量" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/views -keywords: ["analytics", "浏览量", "页面浏览量", "流量", "导出"] ---- - -
- ## 使用方法 -
- -使用此端点导出页面浏览量分析数据。结果包括全站总量和各页面明细，并按人工流量和 AI 流量分类。 - -使用基于偏移量的分页浏览结果。当 `hasMore` 为 `true` 时，将 `offset` 递增 `limit`。 - -
- ## 筛选 -
- -使用 `dateFrom` 和 `dateTo` 参数按日期范围过滤浏览量数据。 diff --git a/zh/api/analytics/visitors.mdx b/zh/api/analytics/visitors.mdx deleted file mode 100644 index eceb08231d..0000000000 --- a/zh/api/analytics/visitors.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "获取唯一访客" -openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/visitors -keywords: ["analytics", "访客", "唯一访客", "流量", "导出"] ---- - -
- ## 使用方法 -
- -使用此端点导出唯一访客分析数据。结果包括全站总量和各页面明细，并按人工流量和 AI 流量分类。`total` 字段已对人工流量和 AI 流量进行去重处理。 - -使用基于偏移量的分页浏览结果。当 `hasMore` 为 `true` 时，将 `offset` 递增 `limit`。 - -
- ## 筛选 -
- -使用 `dateFrom` 和 `dateTo` 参数按日期范围过滤访客数据。 diff --git a/zh/api/assistant/create-assistant-message-v2.mdx b/zh/api/assistant/create-assistant-message-v2.mdx deleted file mode 100644 index f4c5aed117..0000000000 --- a/zh/api/assistant/create-assistant-message-v2.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "创建 assistant 消息" -openapi: /zh/discovery-openapi.json POST /v2/assistant/{domain}/message -keywords: - [ - "assistant message", - "embed", - "chat", - "integrate", - "v2", - "ai sdk v5", - "ai sdk v6" - ] ---- - - - assistant 消息 v2 端点兼容 **AI SDK v5+**。如果你正在使用 AI SDK v4，请改用 [assistant 消息 v1 端点](/zh/api/assistant/create-assistant-message)。 - - -
- ## 与 `useChat` 集成 -
- -Vercel 的 AI SDK 提供的 `useChat` hook 是在你的应用程序中集成 assistant API 的推荐方式。 - - - - ```bash - npm i ai@^6 @ai-sdk/react - ``` - - - - ```tsx - import { useState } from "react"; - import { useChat } from "@ai-sdk/react"; - import { DefaultChatTransport } from "ai"; - - function MyComponent({ domain }) { - const [input, setInput] = useState(""); - - const { messages, sendMessage } = useChat({ - transport: new DefaultChatTransport({ - api: `https://api.mintlify.com/discovery/v2/assistant/${domain}/message`, - headers: { - Authorization: `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: "anonymous", - retrievalPageSize: 5, - context: [ - { - type: "code", - value: 'const example = "code snippet";', - elementId: "code-block-1", - }, - ], - }, - }), - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === "user" ? "User: " : "Assistant: "} - {message.parts - .filter((part) => part.type === "text") - .map((part) => part.text) - .join("")} -
- ))} -
{ - e.preventDefault(); - if (input.trim()) { - sendMessage({ text: input }); - setInput(""); - } - }} - > - setInput(e.target.value)} /> - -
-
- ); - } - ``` - - **必填配置：** - - * `transport` - 使用 `DefaultChatTransport` 来配置 API 连接。 - * `body.fp` - 指纹标识符 (使用 `'anonymous'` 或唯一的用户标识符) 。 - * `body.retrievalPageSize` - 要使用的搜索结果数量 (推荐：5) 。 - - **可选配置：** - - * `body.context` - 提供给 AI 助手的上下文信息数组。每个 context 对象包含： - * `type` - `'code'` 或 `'textSelection'` 之一。 - * `value` - 代码片段或选中的文本内容。 - * `path` (可选) - 源文件或页面的路径。 - * `elementId` (可选) - 包含该 context 的 UI 元素标识符。 - * `body.currentPath` - 用户当前正在查看页面的路径。提供该字段时，AI 助手会利用此 context 提供更相关的回答。最大长度：200 个字符。 - - - -更多详情参见 AI SDK 文档中的 [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) 和 [Transport](https://ai-sdk.dev/docs/ai-sdk-ui/transport)。 - -
- ## 速率限制 -
- -AI 助手 API 有以下限制： - -* 每个 Mintlify 组织每小时最多 10,000 个请求 -* 每个 IP 地址每天最多 10,000 个请求 \ No newline at end of file diff --git a/zh/api/assistant/create-assistant-message.mdx b/zh/api/assistant/create-assistant-message.mdx deleted file mode 100644 index 32d5f01ef0..0000000000 --- a/zh/api/assistant/create-assistant-message.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "创建 AI 助手消息（v1）" -openapi: /zh/discovery-openapi.json POST /v1/assistant/{domain}/message -tag: "已废弃" -keywords: [ "AI 助手消息", "嵌入", "聊天", "集成", "ai sdk v4" ] ---- - -已废弃 - - - assistant message v1 端点与 **AI SDK v4** 兼容。若你使用 AI SDK v5 或更高版本，请改用 [assistant message v2 端点](/zh/api/assistant/create-assistant-message-v2)。 - - -
- ## 与 `useChat` 集成 -
- -将 AI 助手 API 集成到你的应用中的推荐方式是使用 Vercel 的 AI SDK 提供的 `useChat` 钩子。 - - - - ```bash - npm i ai@^4.1.15 - ``` - - - - ```tsx - import { useChat } from 'ai/react'; - - function MyComponent({ domain }) { - const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({ - api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`, - headers: { - 'Authorization': `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`, - }, - body: { - fp: 'anonymous', - retrievalPageSize: 5, - context: [ - { - type: 'code', - value: 'const example = "code snippet";', - elementId: 'code-block-1', - }, - ], - }, - streamProtocol: 'data', - sendExtraMessageFields: true, - }); - - return ( -
- {messages.map((message) => ( -
- {message.role === 'user' ? 'User: ' : 'Assistant: '} - {message.content} -
- ))} -
- - -
-
- ); - } - ``` - - **Mintlify 的必备配置：** - - * `streamProtocol: 'data'` - 流式响应所必需。 - * `sendExtraMessageFields: true` - 发送消息 metadata 所必需。 - * `body.fp` - 指纹标识符 (使用 `'anonymous'` 或某个用户标识符) 。 - * `body.retrievalPageSize` - 要使用的搜索结果数量 (推荐：5) 。 - - **可选配置：** - - * `body.context` - 提供给 AI 助手的上下文信息数组。每个 context 对象包含： - * `type` - `'code'` 或 `'textSelection'` 之一。 - * `value` - 代码片段或选中的文本内容。 - * `elementId` (可选) - 包含该 context 的 UI 元素的标识符。 - * `body.currentPath` - 用户当前正在查看页面的路径。提供后，AI 助手会利用该上下文提供更相关的回答。最大长度：200 个字符。 - - - -在 AI SDK 文档中查看 [useChat](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) 以了解更多详情。 - -
- ## 速率限制 -
- -AI 助手 API 的限制如下： - -* 每个 Mintlify 组织每小时最多 10,000 次请求 -* 每个 IP 每日最多 10,000 次请求 \ No newline at end of file diff --git a/zh/api/assistant/get-page-content.mdx b/zh/api/assistant/get-page-content.mdx deleted file mode 100644 index 6ffe3409e6..0000000000 --- a/zh/api/assistant/get-page-content.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "获取页面内容" -openapi: "/zh/discovery-openapi.json POST /v1/page/{domain}" -keywords: [ "页面", "内容", "检索" ] ---- - -
-## 速率限制 -
- -- 每个 Mintlify 组织每小时 10,000 次请求 diff --git a/zh/api/assistant/search.mdx b/zh/api/assistant/search.mdx deleted file mode 100644 index 6c754f525c..0000000000 --- a/zh/api/assistant/search.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "搜索文档" -openapi: "/zh/discovery-openapi.json POST /v1/search/{domain}" -keywords: [ "搜索", "搜索词" ] ---- - -
-## 速率限制 -
- -- 每个 Mintlify 组织每小时 10,000 次请求 \ No newline at end of file diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index 650e5b3fec..35257f5d5b 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -11,29 +11,29 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 ## 端点 -* [Trigger update](/zh/api/update/trigger)：在需要时触发您站点的更新。 -* [Get update status](/zh/api/update/status)：获取某次更新的状态以及与您的文档相关的其他详细信息。 -* [Trigger preview deployment](/zh/api/preview/trigger)：为特定分支创建或更新预览部署。 -* [Create agent job](/zh/api/agent/v2/create-agent-job)：创建一个代理任务以自动编辑您的文档。 -* [Get agent job](/zh/api/agent/v2/get-agent-job)：获取特定代理任务的详细信息和状态。 -* [Send follow-up message](/zh/api/agent/v2/send-message)：向已有的代理任务发送后续消息。 -* [Create assistant message](/zh/api/assistant/create-assistant-message-v2)：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。 -* [搜索文档](/zh/api/assistant/search)：搜索您的文档。 -* [获取页面内容](/zh/api/assistant/get-page-content)：检索文档页面的完整文本内容。 -* [获取用户反馈](/zh/api/analytics/feedback)：从您的文档中导出用户反馈。 -* [获取 AI 助手会话](/zh/api/analytics/assistant-conversations)：导出 AI 助手的会话历史。 -* [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats)：获取按调用方类型划分的助手查询次数明细。 +- [Trigger update](/zh/api/admin/trigger-update)：在需要时触发您站点的更新。 +- [Get update status](/zh/api/admin/get-update-status)：获取某次更新的状态以及与您的文档相关的其他详细信息。 +- [Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)：为特定分支创建或更新预览部署。 +- [Create agent job](/zh/api/agent/create-agent-job)：创建一个代理任务以自动编辑您的文档。 +- [Get agent job](/zh/api/agent/get-agent-job)：获取特定代理任务的详细信息和状态。 +- [Send follow-up message](/zh/api/agent/send-follow-up-message)：向已有的代理任务发送后续消息。 +- [Create assistant message](/zh/api/assistant/create-assistant-message)：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。 +- [搜索文档](/zh/api/assistant/search-documentation)：搜索您的文档。 +- [获取页面内容](/zh/api/assistant/get-page-content)：检索文档页面的完整文本内容。 +- [获取用户反馈](/zh/api/analytics/get-feedback)：从您的文档中导出用户反馈。 +- [获取 AI 助手会话](/zh/api/analytics/get-assistant-conversations)：导出 AI 助手的会话历史。 +- [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats)：获取按调用方类型划分的助手查询次数明细。
### 常见用例
-* **自动化部署**：使用 [Trigger update](/zh/api/update/trigger) 和 [Get update status](/zh/api/update/status)，在设定的时间间隔或当特定事件发生时触发站点更新。 -* **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/update/trigger)。 -* **预览部署**：使用 [Trigger preview deployment](/zh/api/preview/trigger)，在 CI/CD 流水线中以编程方式创建或更新预览部署。 -* **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。 -* **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job) 和 [Send follow-up message](/zh/api/agent/v2/send-message)。 -* **Analytics 导出**：使用 [Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats)，导出反馈、助手会话和调用方统计数据以进行外部分析。 +- **自动化部署**：使用 [Trigger update](/zh/api/admin/trigger-update) 和 [Get update status](/zh/api/admin/get-update-status)，在设定的时间间隔或当特定事件发生时触发站点更新。 +- **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/admin/trigger-update)。 +- **预览部署**：使用 [Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)，在 CI/CD 流水线中以编程方式创建或更新预览部署。 +- **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message)、[Search documentation](/zh/api/assistant/search-documentation) 和 [Get page content](/zh/api/assistant/get-page-content)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。 +- **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/create-agent-job)、[Get agent job](/zh/api/agent/get-agent-job) 和 [Send follow-up message](/zh/api/agent/send-follow-up-message)。 +- **Analytics 导出**：使用 [Get user feedback](/zh/api/analytics/get-feedback)、[Get assistant conversations](/zh/api/analytics/get-assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats)，导出反馈、助手会话和调用方统计数据以进行外部分析。
## 认证 @@ -47,7 +47,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 ### 管理员 API key
-使用管理员 API key 对发送到 [Trigger update](/zh/api/update/trigger)、[Get update status](/zh/api/update/status)、[Trigger preview deployment](/zh/api/preview/trigger)、[Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job)、[Send follow-up message](/zh/api/agent/v2/send-message)、[Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats) 的请求进行身份验证。 +使用管理员 API key 对发送到 [Trigger update](/zh/api/admin/trigger-update)、[Get update status](/zh/api/admin/get-update-status)、[Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)、[Create agent job](/zh/api/agent/create-agent-job)、[Get agent job](/zh/api/agent/get-agent-job)、[Send follow-up message](/zh/api/agent/send-follow-up-message)、[Get user feedback](/zh/api/analytics/get-feedback)、[Get assistant conversations](/zh/api/analytics/get-assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats) 的请求进行身份验证。 管理员 API key 以 `mint_` 前缀开头。 @@ -57,7 +57,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 ### Assistant API key -使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content) 端点的请求进行认证。 +使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message)、[Search documentation](/zh/api/assistant/search-documentation) 和 [Get page content](/zh/api/assistant/get-page-content) 端点的请求进行认证。 assistant API key 以 `mint_dsc_` 前缀开头。 @@ -65,4 +65,4 @@ assistant API key 是一个公共令牌，你可以在前端代码中引用。 使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。 - + \ No newline at end of file diff --git a/zh/api/preview/trigger.mdx b/zh/api/preview/trigger.mdx deleted file mode 100644 index 11d5911218..0000000000 --- a/zh/api/preview/trigger.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "触发预览部署" -openapi: "/zh/openapi.json POST /project/preview/{projectId}" -keywords: ["preview", "preview deployment", "branch preview", "staging"] ---- - - - 预览部署适用于 [Pro 和 Enterprise 方案](https://mintlify.com/pricing?ref=preview-deployments)。 - - -使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。 - -响应中包含一个 `statusId`，你可以将其传递给 [Get deployment status](/zh/api/update/status) 以跟踪部署进度。 - -
- ## 用例 -
- -- **CI/CD 流水线**：在拉取请求被打开或更新时自动创建预览部署。 -- **定时预览**：按计划为长期运行的功能分支生成预览。 -- **自定义工具**：将预览创建集成到内部工作流或 Slack 机器人中。 - -
- ## 速率限制 -
- -此端点允许每个组织每分钟最多 5 个请求。 diff --git a/zh/api/update/status.mdx b/zh/api/update/status.mdx deleted file mode 100644 index 76144c5c75..0000000000 --- a/zh/api/update/status.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "获取部署状态" -openapi: "/zh/openapi.json GET /project/update-status/{statusId}" -keywords: [ "更新状态", "部署状态", "查看状态" ] ---- \ No newline at end of file diff --git a/zh/api/update/trigger.mdx b/zh/api/update/trigger.mdx deleted file mode 100644 index 81dc8c8eb5..0000000000 --- a/zh/api/update/trigger.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "触发部署" -openapi: "/zh/openapi.json POST /project/update/{projectId}" -keywords: [ "触发", "更新", "部署", "以编程方式" ] ---- \ No newline at end of file diff --git a/zh/discovery-openapi.json b/zh/discovery-openapi.json index 712811dfce..1c34bc301a 100644 --- a/zh/discovery-openapi.json +++ b/zh/discovery-openapi.json @@ -19,6 +19,8 @@ "/v1/assistant/{domain}/message": { "post": { "summary": "AI 助手消息 v1", + "deprecated": true, + "x-hidden": true, "description": "为指定的 domain 生成 AI 助手的回复消息。兼容 AI SDK v4。", "parameters": [ {