Bluescape API Guides Landing Page

This is a list of guides that describes and breaks down using both REST and GraphQL to interact with Bluescape APIs. Each section contains walkthroughs for performing each task with both the REST and GraphQL methods, while also providing full code examples of each in multiple languages.

We also provide Postman Collections and Sample Applications to help developers with real world examples and tools.

Getting Started

1. Application Authorization

In order for applications to access the Bluescape API they must be authorized by an existing Bluescape user. The Application Authorization guide explains how to use your application’s credentials to obtain this authorization.
Open Guide

2. Basic API Request

Once an application has received an access token, it is free to start accessing the Bluescape API. The Basic API Request guide presents some example requests to get you started with creating your application.
Open Guide

3. Get list of workspaces

Get the list of all Workspaces that you can access. With this, you can get the IDs and names of each Workspace.
Open Guide

4. Get all images from a Workspace

Get the information for all the images uploaded in your Workspace. You can easily extend this script to download documents, notes, etc.
Open Guide

5. Create a Canvas and add a Text to it

Here you will learn how to create a new Canvas and how to add a Text to it. Creating a Canvas is very useful for organizing elements in a Workspace.
Open Guide

6. Upload content into a Canvas

Learn how to automate the uploading of documents, images and videos from a local folder on your hard drive, or from a URL, to a new Canvas.
Open Guide)

7. Find elements in a workspace

Learn how to find elements in the workspace that match a specific text string.
Open Guide

8. Find an empty area to add content

Learn how to find an empty area in a workspace, to be sure that the new elements you add there do not overlap over previously existing elements.
Open Guide

Where to Next?

Not what you were looking for? Reply below or Search the community and discover more Bluescape.