Skip to content

Commit

Permalink
Update api-access.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashlynbain authored Oct 2, 2024
1 parent 2c1981f commit a9299b0
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions docs/watsonx-assistant/api-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,44 +13,46 @@ This page will demonstrate how to access watsonx Assistant via an API call.

1. Access watsonx Assistant from Resource List in the IBM Cloud Account

![test](../assets/api-access/resource.png)
![test](../assets/api-access/resource.png)

2. Get API Key for watsonx Assistant from Launch webpage
![test](../assets/api-access/api.png)
![test](../assets/api-access/api.png)

3. Get Serice Instance URL from Launch webpage
![test](../assets/api-access/url.png)
![test](../assets/api-access/url.png)

4. Get Assistant ID from webpage within the Assistant settings

- Head to the Homepage of your assistant:
![test](../assets/api-access/assistant-page.png)
![test](../assets/api-access/assistant-page.png)

- Access the Assistant Settings on the bottom left corner of the page:
![test](../assets/api-access/assistant-settings.png)
![test](../assets/api-access/assistant-settings.png)

- Select *View details* on the Assistant IDs and API details section of the page:
![test](../assets/api-access/view-details.png)
![test](../assets/api-access/view-details.png)

- Get the required information from this pop-up window:
![test](../assets/api-access/details.png)
![test](../assets/api-access/details.png)

5. Copy the Skill ID from the watsonx Assistant settings

6. Obtain the Session ID from CLI CURL

```{}
curl -X POST -u "apikey:{apikey}" "{url}/v2/assistants/{environment_id}/sessions?version=2021-11-27"
```
```{}
curl -X POST -u "apikey:{apikey}" "{url}/v2/assistants/{environment_id}/sessions?version=2021-11-27"
```
7. Get all parameters from CLI CURL

```{}
curl -X GET -u "apikey:{apikey}" "{url}/v2/assistants/{assistant_id}/skills/{skill_id}?version=2021-11-27"
```
```{}
curl -X GET -u "apikey:{apikey}" "{url}/v2/assistants/{assistant_id}/skills/{skill_id}?version=2021-11-27"
```

8. 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"
```
```{}
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"
```

Cheers! Now you can chat with your watsonx Assistant via API.

0 comments on commit a9299b0

Please sign in to comment.