API + A.I. Access · PeekSmith
About
With the “API Access” PeekSmith app premium add-on you can send data from the PeekSmith app to any 3rd party WEB API, so you can integrate with other magic apps easily. You will also be able to use A.I. based features in the app, using your own OpenAI API key (see below).
It is a premium add-on, you can buy separately.
The price of the add-on is 25 EUR (one-time fee). Purchase the add-on here: bsmagic.app/payment/?item=sendtoapi
Using API Access
To use the API Access add-on, follow these steps:
- Open the PeekSmith app and go to the Settings tab.
- In the Settings menu, navigate to the Add-On Features section.
- You can manage URLs for data transmission by tapping on the Manage button next to the “Send Text to WEB API”.
- Each URL can be customized to include data from PeekSmith by adding the hashtag and text (in all capitals) to specify where the data should be inserted.
The URLs can be personalized to different apps or services, and multiple URLs can be enabled simultaneously, sending the same data to each destination. Users can add, edit, disable, or delete URLs as needed.
If a URL starts with “http” or “https,” the data is sent in the background without opening any web pages within the PeekSmith app. However, if a custom URL scheme is used (not starting with “http”), it will open in a browser window or switch to the other app to complete the data transfer.
For more details, please watch the video above. The features are demonstrated with various examples, such as setting a time on a connected watch or interacting with NFC cards. Additionally, it mentions using web APIs as well.
Overall, the “API Access” add-on provides a versatile and powerful tool for extending the functionality of the PeekSmith app by connecting it with other apps, services, or web-based systems.
Using A.I. Functions (Text Recognition, etc.)
If you already have the “API + A.I. access” add-on, you can enter your own OpenAI API key to be able to use A.I. based features, like text recognition, image analysis and more.
Obtaining Your OpenAI API Key
To be able to use A.I. text recognition (also drawing recognition and analysis), you will need to get an OpenaAI API key, and top up your balance (performing one routine will cost you only 0.01 USD).
Follow these steps to get your OpenAI API key, to use in the PeekSmith app:
- create an OpenAI account:
https://platform.openai.com/signup - go to your billing overview:
https://platform.openai.com/account/billing/overview - add your payment details
- top up your API balance (with at least 10 USD)
- create an API key:
https://platform.openai.com/api-keys
IMPORTANT: copy your API key as soon as you create it, you won’t be able to view/copy it later!!! - in the PeekSmith app go to Settings, and scroll down to the API + A.I. ACCESS ADD-ON section
- paste your API key to “Your OpenAI API key”
- select your language at “A.I. language”
- in TEXT RECOGNITION settings select A.I. (GPT-4o or 4o-mini) as the recognition engine