Viewing the API Documentation

An Open API definition is used to generate the API documentation. There are two ways to view the document:

• Access the document on your Graph Studio server at the following URL:

  https://<hostname>/api/docs/index.html

  In releases prior to 5.4.2, the URL to view the documentation on your server is https://<hostname>/api/v1/docs/index.html.

  Where <hostname> is the Graph Studio server DNS name or IP address. When you access the API documentation on your server, a Try It Out button is available for each request. Clicking Try It Out opens a request body that you can edit and execute against the server.

• Access the document on the Altair documentation website here.

  This version of the documentation is static and the Try It Out functionality is disabled. However, it remains available if you are unable to access the Graph Studio server.