update openapi docs and configure number (vocodedev#378)

* update openapi docs and configure number * bump with prompts and actually correct docs * mintlify generate * updates sidebar * vector DB docs --------- Co-authored-by: Ajay Raj <[email protected]>
m5a0r7 · Aug 26, 2023 · 8834a4d · 8834a4d
1 parent 83e0ab4
commit 8834a4d
Show file tree

Hide file tree

Showing 19 changed files with 496 additions and 16 deletions.
diff --git a/docs/api-reference/actions/get-action.mdx b/docs/api-reference/actions/get-action.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/actions
----
+---
diff --git a/docs/api-reference/agents/get-agent.mdx b/docs/api-reference/agents/get-agent.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/agents
----
+---
diff --git a/docs/api-reference/calls/get-call.mdx b/docs/api-reference/calls/get-call.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/calls
----
+---
diff --git a/docs/api-reference/calls/get-recording.mdx b/docs/api-reference/calls/get-recording.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/calls/recording
+---
diff --git a/docs/api-reference/numbers/get-number.mdx b/docs/api-reference/numbers/get-number.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/numbers
----
+---
diff --git a/docs/api-reference/prompts/create-prompt.mdx b/docs/api-reference/prompts/create-prompt.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/prompts/create
+---
diff --git a/docs/api-reference/prompts/get-prompt.mdx b/docs/api-reference/prompts/get-prompt.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/prompts
+---
diff --git a/docs/api-reference/prompts/list-prompts.mdx b/docs/api-reference/prompts/list-prompts.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/prompts/list
+---
diff --git a/docs/api-reference/prompts/update-prompt.mdx b/docs/api-reference/prompts/update-prompt.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/prompts/update
+---
diff --git a/docs/api-reference/usage/get-usage.mdx b/docs/api-reference/usage/get-usage.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/usage
----
+---
diff --git a/docs/api-reference/vector_databases/create-vector-database.mdx b/docs/api-reference/vector_databases/create-vector-database.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/vector_databases/create
+---
diff --git a/docs/api-reference/vector_databases/get-vector-database.mdx b/docs/api-reference/vector_databases/get-vector-database.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/vector_databases
+---
diff --git a/docs/api-reference/vector_databases/list-vector-databases.mdx b/docs/api-reference/vector_databases/list-vector-databases.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/vector_databases/list
+---
diff --git a/docs/api-reference/vector_databases/update-vector-database.mdx b/docs/api-reference/vector_databases/update-vector-database.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/vector_databases/update
+---
diff --git a/docs/api-reference/voices/get-voice.mdx b/docs/api-reference/voices/get-voice.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/voices
----
+---
diff --git a/docs/api-reference/webhooks/get-webhook.mdx b/docs/api-reference/webhooks/get-webhook.mdx
@@ -1,3 +1,3 @@
 ---
 openapi: get /v1/webhooks
----
+---
diff --git a/docs/configuring-number.mdx b/docs/configuring-number.mdx
@@ -31,9 +31,9 @@ prompt so the AI responds like Yoda.
 <CodeGroup>
 
 ```python Python
-from vocode import AgentUpdateParams
+from vocode import AgentUpdateParams, PromptUpdateParams
 
-yoda_prompt = "I want you to act as Yoda. Respond as Yoda would."
+yoda_prompt = PromptUpdateParams(content="I want you to act as Yoda. Respond as Yoda would.")
 number = vocode_client.numbers.update_number(
     phone_number="YOUR_NUMBER", inbound_agent=AgentUpdateParams(prompt=yoda_prompt)
 )
@@ -43,7 +43,7 @@ number = vocode_client.numbers.update_number(
 const yoda_prompt = "I want you to act as Yoda. Respond as Yoda would.";
 const number = await vocode.numbers.updateNumber({
   phoneNumber: "YOUR_NUMBER",
-  inboundAgent: { prompt: yoda_prompt },
+  inboundAgent: { prompt: { content: yoda_prompt } },
 });
 ```
 

diff --git a/docs/mint.json b/docs/mint.json
@@ -99,7 +99,8 @@
         "api-reference/calls/list-calls",
         "api-reference/calls/get-call",
         "api-reference/calls/end-call",
-        "api-reference/calls/create-call"
+        "api-reference/calls/create-call",
+        "api-reference/calls/get-recording"
       ]
     },
     {
@@ -124,6 +125,24 @@
         "api-reference/agents/update-agent"
       ]
     },
+    {
+      "group": "Prompts",
+      "pages": [
+        "api-reference/prompts/get-prompt",
+        "api-reference/prompts/list-prompts",
+        "api-reference/prompts/create-prompt",
+        "api-reference/prompts/update-prompt"
+      ]
+    },
+    {
+      "group": "Vector Databases",
+      "pages": [
+        "api-reference/vector_database/get-prompt",
+        "api-reference/vector_database/list-prompts",
+        "api-reference/vector_database/create-prompt",
+        "api-reference/vector_database/update-prompt"
+      ]
+    },
     {
       "group": "Voices",
       "pages": [