Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.optisigns.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Started

Start integrating with OptiSigns API by following these simple steps:

​
1. Access the GraphQL IDE

The fastest way to explore and test the API is through our web-based GraphQL IDE: bash https://graphql-gateway.optisigns.com/graphql This interactive environment allows you to: - Write and test queries - Explore available schema - View real-time results

​
2. Authentication

  1. Get your API key from the account settings or follow the instructions on the Generate API Key page. 2. Include the API key in your request headers 3. All API requests require authentication

​
Core API Operations

​
Query Operations

Fetch all devices in your account:
query{
  devices (query : {}) {
    page{
      edges{
        cursor,
        node{
          _id,
          deviceName,
          UUID,
          pairingCode,
          currentType,
          currentAssetId,
          currentPlaylistId,
          localAppVersion,
        }
      }
    }
  }
}
Example Response:
{
  "data": {
    "devices": {
      "page": {
        "edges": [
          {
            "cursor": "YXJyYXljb2luZW50aW9uOjA=",
            "node": {
              "_id": "G158712f0e404274e7300e7f",
              "deviceName": "TOMATO",
              "UUID": "c1af1246-d1c8-3e7c-a04b-9914579f5342",
              "pairingCode": "5MMESU",
              "currentType": "asset",
              "currentAssetId": "TQ7d4Nc4kZhjwF29F",
              "currentPlaylistId": null,
              "localAppVersion": "5.5.8"
            }
          }
        ]
      }
    }
  }
}
Retrieve asset details by filename:
query{
  assets (query : {originalFileName:"Sample Image 1.JPG"}) {
    page{
      edges{
        cursor,
        node{
          _id,
          appType,
          fileType,
          name,
          filename
        }
      }
    }
  }
}
Example Response:
{
  "data": {
    "assets": {
      "page": {
        "edges": [
          {
            "cursor": "YXJyYXljb2luZW50aW9uOjA=",
            "node": {
              "_id": "fAzD64mkENvCtde3p",
              "appType": null,
              "fileType": "image",
              "name": null,
              "filename": "Sample Image 1.JPG"
            }
          }
        ]
      }
    }
  }
}

​
Next Steps

API Reference

Explore the complete API schema and operations

Device Management

Learn about device control and monitoring

Content Management

Manage digital signage content and playlists

Best Practices

Tips for optimal API integration