Before you begin!
Visit the Wetrocloud console to get your API key. If you have trouble obtaining it, refer to this guide.
Visit the Wetrocloud console to get your API key. If you have trouble obtaining it, refer to this guide.
Introduction
This guide is for developers looking to get started with the WetroCloud API quickly. Using simple cURL commands, you’ll learn how to:- Create a collection
- Insert resources into the collection
- Query collection for answers
- Chat with collection for conversations
- Categorize resources
- Remove resources
- Delete Collection
- An API key from the Wetrocloud Console
Important!
Always prefix your API key with
Always prefix your API key with
Token
(including a space). Example: Token YOUR_API_KEY
. Requests without this format will be rejected.1
Getting Started
2
Setting Up API Key
3
Create a Collection
First, create a
collection_id
to group your resources.4
List all available collections
After creating a collection, you can get all your available collections on wetrocloud.
5
Insert a Resource into the Collection
Add a resource to your collection using the
collection_id
you created earlier6
Query Collection
Query your collection using the
collection_id
created earlier by providing a query in the request_query
field.To keep things simple we made use of the
/collection/query/
endpoint without structured output
7
Chat with Collection
Chat with your collection using the
collection_id
created earlier by providing a message in the message
field and continue conversations by passing chat_history
.8
Categorize a Resource
9
Remove a Resource
Remove a resource from your collection using the
collection_id
and resource_id
.10
Delete a Collection
Delete a collection using its
collection_id
.