Merge pull request #209 from Cognigy/docs-api-note

docs: add note and link about api baseurl
Cognigy · Feb 12, 2025 · 7415461 · 7415461
2 parents dbf92e4 + cfb8ed3
commit 7415461
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,5 @@ coverage/
 playbooks.json
 playbookRunResults.json
 config.**.json
-config.json
+config.json
+.idea
diff --git a/README.md b/README.md
@@ -58,6 +58,8 @@ The Cognigy.AI CLI needs the following configuration:
 | agentDir               | The folder where you want to store the agent locally | CAI_AGENTDIR                 |
 | playbookTimeoutSeconds | Timeout for checking playbook runs                   | CAI_PLAYBOOK_TIMEOUT_SECONDS |
 
+NOTE: [The API Base URL is the endpoint for accessing the Cognigy.AI OpenAPI](https://docs.cognigy.com/ai/developers/api-and-cli/#the-api-base-url).
+
 Both environment configuration and file-based configuration can be used together. Environment configuration takes priority.
 
 ## Commands