diff --git a/api-reference/assistant/create-assistant-topic.mdx b/api-reference/assistant/create-assistant-topic.mdx new file mode 100644 index 000000000..9d53627c9 --- /dev/null +++ b/api-reference/assistant/create-assistant-topic.mdx @@ -0,0 +1,116 @@ +--- +title: "Create Assistant Topic" +api: "POST https://api.example.com/assistant/topics" +description: "Create a new assistant topic to organize conversations and interactions." +--- + +## Overview + +This endpoint allows you to create a new assistant topic. Topics help organize and categorize assistant conversations, making it easier to manage different discussion threads or subjects. + +## Request + + + The name of the assistant topic + + + + Optional description for the assistant topic + + + + Array of tags to categorize the assistant topic + + +## Response + + + Unique identifier for the created assistant topic + + + + Name of the assistant topic + + + + Description of the assistant topic + + + + Tags associated with the assistant topic + + + + Timestamp when the assistant topic was created + + + + Timestamp when the assistant topic was last updated + + +## Example + + + +```bash cURL +curl -X POST https://api.example.com/assistant/topics \ + -H "Authorization: Bearer YOUR_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "Customer Support Assistant", + "description": "Assistant topic for handling customer support inquiries", + "tags": ["support", "customer-service"] + }' +``` + +```javascript JavaScript +const response = await fetch('https://api.example.com/assistant/topics', { + method: 'POST', + headers: { + 'Authorization': 'Bearer YOUR_API_KEY', + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + name: 'Customer Support Assistant', + description: 'Assistant topic for handling customer support inquiries', + tags: ['support', 'customer-service'] + }) +}); + +const assistantTopic = await response.json(); +``` + +```python Python +import requests + +url = "https://api.example.com/assistant/topics" +headers = { + "Authorization": "Bearer YOUR_API_KEY", + "Content-Type": "application/json" +} +data = { + "name": "Customer Support Assistant", + "description": "Assistant topic for handling customer support inquiries", + "tags": ["support", "customer-service"] +} + +response = requests.post(url, headers=headers, json=data) +assistant_topic = response.json() +``` + + + + + +```json Response +{ + "id": "topic_12345", + "name": "Customer Support Assistant", + "description": "Assistant topic for handling customer support inquiries", + "tags": ["support", "customer-service"], + "created_at": "2023-11-20T10:30:00Z", + "updated_at": "2023-11-20T10:30:00Z" +} +``` + + \ No newline at end of file diff --git a/api-reference/assistant/generate-assistant-message.mdx b/api-reference/assistant/generate-assistant-message.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/api-reference/chat/create-topic.mdx b/api-reference/chat/create-topic.mdx deleted file mode 100644 index 30ad8b74f..000000000 --- a/api-reference/chat/create-topic.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/topic ---- \ No newline at end of file diff --git a/api-reference/chat/generate-message.mdx b/api-reference/chat/generate-message.mdx deleted file mode 100644 index 30a74c542..000000000 --- a/api-reference/chat/generate-message.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/message ---- \ No newline at end of file diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 06ea36885..f3d4c4407 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -34,4 +34,4 @@ Responses include citations so you can point your users to the right places they Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use -the API for AI assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). +the API for AI assistant. You can also see a deployed version of this example at [assistant.mintlify.com](https://assistant.mintlify.com). \ No newline at end of file diff --git a/docs.json b/docs.json index f20329ea9..88f4a6a89 100644 --- a/docs.json +++ b/docs.json @@ -92,14 +92,14 @@ "group": "MDX", "icon": "markdown", "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" ] }, "api-playground/troubleshooting" ] }, - { + { "group": "Authentication and Personalization", "pages": [ "settings/authentication-personalization/authentication", @@ -158,7 +158,6 @@ "advanced/dashboard/sso", "advanced/dashboard/permissions", "advanced/dashboard/roles" - ] } ] @@ -217,7 +216,7 @@ { "group": "Version Control and CI/CD", "pages": [ - "settings/github", + "settings/github", "settings/gitlab", "settings/ci", "settings/preview-deployments" @@ -246,8 +245,8 @@ { "group": "Assistant", "pages": [ - "api-reference/chat/create-topic", - "api-reference/chat/generate-message" + "api-reference/assistant/create-assistant-topic", + "api-reference/assistant/generate-assistant-message" ] } ]