SHARE Integration Guide

This guide will walk you through integrating the SHARE API with your OpenAssistantGPT chatbot.

Overview

SHARE aggregates and provides access to a vast collection of research outputs and scholarly activities. The service offers metadata about research papers, datasets, and other scholarly products from numerous institutions. It features comprehensive search capabilities, metadata harvesting, and research analytics tools.

Integration Steps

1. Review API Documentation

First, visit the SHARE API documentation to understand the available endpoints and how they work.

2. Create Custom Action

In your OpenAssistantGPT dashboard:

1. Go to the Actions Dashboard
2. Click "Create New Action"
3. Chose Get or Post
4. Fill the action form with the following details:

Name: get_share_data

Description: Get data using SHARE

URL: https://share.osf.io/api/v2/?ref=public_apis&utm_medium=website

Parameters: This will depend on the API you are integrating. Parameters are query parameters passed in the URL.

3. Assign Action to Your Chatbot

1. Go to your Chatbot Dashboard
2. Select your chatbot
3. Go to "Settings" > "Actions"
4. Add the get_share_data action to your chatbot

Using the Integration

Your chatbot can now handle science & math-related queries. Here are some example questions you can ask:

• Find open research datasets in biology
• Search for scholarly outputs from universities
• Get metadata about research projects

The chatbot will automatically use the SHARE API to fetch and return the requested information.

Additional Resources

• SHARE API Documentation
• OpenAssistantGPT Actions Guide
• Custom Action Tutorial