fix: update agent.yaml to include endpoint metadata

api/agent.yaml

@@ -6,7 +6,11 @@ info:
 paths:
   /ask:
     post:
+      tags:
+        - Agent
       summary: Ask Request
+      description: Interact with the WordLift Agent to process a message and receive
+        an AI-driven response.
       operationId: ask_request_api_ask_post
       requestBody:
         content:

docs/api/agent/ask-request-api-ask-post.api.mdx

@@ -1,11 +1,11 @@
 ---
 id: ask-request-api-ask-post
 title: "Ask Request"
-description: "Ask Request"
+description: "Interact with the WordLift Agent to process a message and receive an AI-driven response."
 sidebar_label: "Ask Request"
 hide_title: true
 hide_table_of_contents: true
-api: {"operationId":"ask_request_api_ask_post","requestBody":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message"},"model":{"type":"string","title":"Model","default":"gpt-4o"},"security":{"type":"boolean","title":"Security","default":false}},"type":"object","required":["message"],"title":"AskRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"response":{"type":"string","title":"Response"}},"type":"object","required":["response"],"title":"AskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}],"description":"Ask Request","method":"post","path":"/ask","servers":[{"url":"https://api.wordlift.io/agent","description":"WordLift Agent API"}],"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"authorization"}},"jsonRequestBodyExample":{"message":"string","model":"gpt-4o","security":false},"info":{"title":"WordLift Agent API","description":"API for interacting with the WordLift Agent","version":"1.0.0"},"postman":{"name":"Ask Request","description":{"type":"text/plain"},"url":{"path":["ask"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
+api: {"tags":["Agent"],"description":"Interact with the WordLift Agent to process a message and receive an AI-driven response.","operationId":"ask_request_api_ask_post","requestBody":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message"},"model":{"type":"string","title":"Model","default":"gpt-4o"},"security":{"type":"boolean","title":"Security","default":false}},"type":"object","required":["message"],"title":"AskRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"response":{"type":"string","title":"Response"}},"type":"object","required":["response"],"title":"AskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}],"method":"post","path":"/ask","servers":[{"url":"https://api.wordlift.io/agent","description":"WordLift Agent API"}],"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"authorization"}},"jsonRequestBodyExample":{"message":"string","model":"gpt-4o","security":false},"info":{"title":"WordLift Agent API","description":"API for interacting with the WordLift Agent","version":"1.0.0"},"postman":{"name":"Ask Request","description":{"content":"Interact with the WordLift Agent to process a message and receive an AI-driven response.","type":"text/plain"},"url":{"path":["ask"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
 sidebar_class_name: "post api-method"
 info_path: api/agent/wordlift-agent-api
 custom_edit_url: null
@@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem";
 
 
 
-Ask Request
+Interact with the WordLift Agent to process a message and receive an AI-driven response.
 
 <MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"Message"} qualifierMessage={undefined} schema={{"type":"string","title":"Message"}}></SchemaItem><SchemaItem collapsible={false} name={"model"} required={false} schemaName={"Model"} qualifierMessage={undefined} schema={{"type":"string","title":"Model","default":"gpt-4o"}}></SchemaItem><SchemaItem collapsible={false} name={"security"} required={false} schemaName={"Security"} qualifierMessage={undefined} schema={{"type":"boolean","title":"Security","default":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>