Sessions

Overview A Studio Session is a collaborative environment in which multiple participants can place markups on the same drawing simultaneously or asynchronously. This page covers the general life cycle of a Studio Session and includes code examples. Visit our Example Workflows page to see a common application of the Sessions [...]

Example Workflows

Overview In the Functionality page, we've seen the various API functions available for Studio Sessions, Studio Projects and Studio Project File Jobs. While the possibilities of utilizing these functions are innumerable, we have selected some common workflows that the Studio API can support. Get the gears turning with these common [...]

Getting Started

Overview The Bluebeam Studio API gives access to our document-based collaboration platform, Studio, and opens up lines of communication for seamless integration between Studio and your systems. The Studio API is RESTful and uses the following standards: Authentication with OAuth 2.0 All requests and response bodies must be JSON formatted. [...]

Branding Guidelines

Overview We're happy that you've chosen to build an App with the Studio API! Below are guidelines that you'll need to follow in order for us to approve your App for production. These guidelines will help when referencing Bluebeam and your relationship to us in your marketing, App naming, branding [...]

Common Response Codes

Common HTML Response Codes HTTP Code Message Definition 200 OK The request succeeded. 201 Created The request succeeded and resulted in the creation of new resources. 204 No Content The server fulfilled the request and does not need to return an entity-body. 400 Bad Request The request could not be [...]

Approval Process

Overview Before your App can be made available in an official production capacity, it will need to be approved by Bluebeam's Integrations team. By now, you will have gone through most of the Development Process. When to Request Production Credentials When you have finished developing your App, and you are [...]

App Management

Overview Once your developer account has been approved, you will gain access to the Development Environment, where you can: Register your App Find the API key associated with that App Manage your existing Apps Test out API calls in the Interactive Console Registering Your App To create an App and generate [...]

Authentication

Overview Requests to all Studio API endpoints must be authenticated. Apps connect to Studio using OAuth 2.0, which is the standard used by most APIs to authenticate and authorize users. This guide will show you how to get an access_token to authenticate with, on behalf of a user, in your [...]

Studio API FAQ

What is the Bluebeam Studio API? The Bluebeam Studio Platform API is the set of access points that allow other applications to interact and integrate with Studio data. Using the Studio API, a developer can write software to get Studio information and perform Studio functions. The list of functionalities available [...]

Studio API Functionality

Overview The Studio API is broken up into three categories: 1) Studio Sessions 2) Studio Projects and 3) Studio Project File Jobs ("Jobs" for short). The calls related to Studio Sessions and Studio Projects provide control and access to Sessions and Projects themselves, as well as their Users, Permissions, Files [...]