From df002ee7a6ec88e92320bda7ca2fff70fb4a0755 Mon Sep 17 00:00:00 2001 From: Ashlyn Bain <70441757+ashlynbain@users.noreply.github.com> Date: Wed, 2 Oct 2024 10:59:45 -0500 Subject: [PATCH] Update api-access.md --- docs/watsonx-assistant/api-access.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/watsonx-assistant/api-access.md b/docs/watsonx-assistant/api-access.md index 7fcfd8b..456f455 100644 --- a/docs/watsonx-assistant/api-access.md +++ b/docs/watsonx-assistant/api-access.md @@ -12,7 +12,6 @@ This page will demonstrate how to access watsonx Assistant via an API call. ## Steps: 1. Access watsonx Assistant from Resource List in the IBM Cloud Account - ![test](../assets/api-access/resource.png) 2. Get API Key for watsonx Assistant from Launch webpage @@ -22,33 +21,26 @@ This page will demonstrate how to access watsonx Assistant via an API call. ![test](../assets/api-access/url.png) 4. Copy the Assistant ID and the Skill ID from the Assistant settings - - + Head to the Homepage of your assistant: + - Head to the Homepage of your assistant: ![test](../assets/api-access/assistant-page.png) - - + Access the Assistant Settings on the bottom left corner of the page: + - Access the Assistant Settings on the bottom left corner of the page: ![test](../assets/api-access/assistant-settings.png) - - + Select *View details* on the Assistant IDs and API details section of the page: + - Select *View details* on the Assistant IDs and API details section of the page: ![test](../assets/api-access/view-details.png) - - + Get the required information from this pop-up window: + - Get the required information from this pop-up window: ![test](../assets/api-access/details.png) 5. Obtain the Session ID from CLI CURL - ```{} curl -X POST -u "apikey:{apikey}" "{url}/v2/assistants/{environment_id}/sessions?version=2021-11-27" ``` 6. Get all parameters from CLI CURL - ```{} curl -X GET -u "apikey:{apikey}" "{url}/v2/assistants/{assistant_id}/skills/{skill_id}?version=2021-11-27" ``` 7. Run Query from CLI CURL as API call to watsonx Agent - ```{} curl -X POST -u "apikey:{apikey}" --header "Content-Type:application/json" --data "{\"input\": {\"text\": \"Hello\"}}" "{url}/v2/assistants/{environment_id}/sessions/{session_id}/message?version=2024-08-25"