The Milestone AI Bridge reference manual

The Milestone AI Bridge reference manual provides reference material about the Milestone AI Bridge GraphQL API andits elements. It also contains the GraphiQL and GraphQL Voyager services, which are two GraphQL services that you can use to test your GraphQL queries and get an overview of the GraphQL API.

GraphiQL is a browser-based user interface that can be used for editing, testing and executing GraphQL queries and mutations against a GraphQL API. GraphiQL enables you to correctly structure your GraphQL queries.

Additionally, you can use the GraphiQL to experiment and build your queries using live data from a real VMS and is a good resource for exploring and learning the API.

GraphiQL enables you to access the API's documentation directly and includes syntax highlighting, intellisense, auto-completion as well as automatic documentation.

GraphiQL is enabled when running in debug mode.

If Milestone AI Bridge is deployed on localhost, you can access GraphiQL at http://localhost:4000/api/bridge/graphql.

GraphQL Voyager enables you to visually explore the GraphQL API as an interactive graph, helping you get an overview of how everything connects.

You can access GraphQL Voyager at http://localhost:4000/voyager. The Milestone AI Bridge reference manual content is also available directly in GraphQL Voyager.

Accessing the reference manual

The reference manual can be accessed as a web page hosted by Milestone AI Bridge but only if you have deployed Milestone AI Bridge to run in debug mode.

If Milestone AI Bridge is running in production mode, you cannot access the Milestone AI Bridge reference manual unless you download a copy and access the manual locally.

The reference manual is accessed through port 4000 (for example http://localhost:4000).

If you are using Kubernetes

You can access the Milestone AI Bridge Reference Manual from outside the Kubernetes cluster by using the following URL: http://<kubernetes-cluster-hostname>:4000 where <kubernetes-cluster-hostname> is the hostname of your Kubernetes cluster.

The GraphiQL query interface is accessed by using the following URL: http://<kubernetes-cluster-hostname>:4000/api/bridge/graphql.

GraphQL Voyager is accessed by using the following URL: http://<kubernetes-cluster-hostname>:4000/voyager.

If you are using docker compose

You can access the Milestone AI Bridge Reference Manual on the host running Docker Compose by using the following URL: http://<hostname-of-aibridge>:4000 where <hostname-of-aibridge> is the hostname of your machine.

The GraphiQL query interface is accessed by using the following URL: http://<hostname-of-aibridge>:4000/api/bridge/graphql.

GraphQL Voyager is accessed by using the following URL: http://<hostname-of-aibridge>:4000/voyager.

Download a local copy

The Milestone AI Bridge reference manual can also be downloaded and unpacked locally. You can access the content by opening the Index.htm file in the aibridge_reference_manual folder in a browser.

The GraphiQL and GraphQL Voyager services will not be available when opening a downloaded local copy of the Milestone AI Bridge reference manual.

For more information about where to download Milestone AI Bridge resources, see Milestone AI Bridge resource location.