Superface allows you to connect to external APIs and SaaS platforms in two ways.
- Using your own credentials. This is good for personal GPTs or where you are happy to share that access with others.
- User-provided credentials. This will ensure that the end users of your GPT can supply their own credentials in order to access a specific API or platform.
This guide covers User-provided credentials.
Selecting User Authentication
In your account you can select which authentication type you want to use for your GPT, and you can edit this at any time by clicking on GPT Actions.
Your authentication choice will be automatically saved.
Authentication flow for users
With Use GPT user-provided credentials selected, the users of your GPT will need to login, or supply their own API keys, to access use the tools you have added to Superface.
The flow for that authentication works like this:
- A user of your GPT writes a prompt (requesting a list of chats from Microsoft Teams, for example).
- Superface responds with a message asking them to configure the tool for themselves by providing their account information (show below).
- The user clicks the link to provide their authentication. This will open a new window for the authentication service provided by Superface.
- After authenticating successfully, the user will redirected back to the authentication page.
The user can now confirm that the required authentication is in place and their original prompt will be re-tried.
Superface uses a temporary ID provided by OpenAI to recognize the users of your GPT. This ID is valid for up to 24 hours, but can expire at any time. If the ID expires, the user must provide their credentials again.