https://youtu.be/k6sKmBgX9g0

Accessing the Sandcastles API

To integrate research data into your own tools using the Sandcastles API, navigate to the Settings section of the web application. From there, select Connectors from the left-hand menu.

Generating an API Key

  1. In the Connectors section, you will find an API area.
  2. Click the Generate API key button.
  3. A pop-up window will appear asking you to enter a name for your API key. Provide a descriptive name (e.g., "My Project API Key").
  4. Click Generate.
  5. Your API key will be created and displayed. This is the only time the full key will be shown. Copy it immediately and store it securely. If you lose it, you will need to regenerate a new one.
  6. Click Done to close the key creation window.

Downloading Code Samples

Once your API key is generated, you can download code samples to help you get started:

  1. Under your generated API key, click on Download code sample.
  2. Choose the programming language you wish to use (e.g., Python, Node.js, Bash).
  3. The corresponding code sample will be downloaded.

API Documentation

For detailed information on available endpoints, schemas, and usage, you can access the official API documentation at: https://api.sandcastles.ai/docs

This documentation includes: