Helium Endpoints

Launch, batch-process, deploy, and monitor Helium-powered widgets and assets.

QueryHeliumBatch1 pt

Fetch Helium batch operation result

Retrieves the result or status of a batch operation within the Helium deployment system, identified by both a deployment key and a site nickname. This query is typically used to poll or retrieve the outcome of a previously initiated batch process, such as a bulk asset compilation or deployment batch job. The response is a raw string, which may be a status code, JSON payload, or other structured data depending on the batch operation performed.

Arguments

Name	Type	Required	Description
key	String!	Yes	The deployment key identifying the Helium session or environment, typically obtained from a prior HeliumLaunchData call.
nickname	String!	Yes	The short name or slug identifying the Helium-enabled site or environment associated with the batch operation.

Returns

Field	Type	Description
HeliumBatch	String!	A string containing the result or status of the Helium batch operation. The format of this string depends on the batch job type.

Example

query HeliumBatch {
  HeliumBatch(key: "hlm_k9f2x7qzLmNpRtVw", nickname: "my-learning-portal")
}

Example Response

{
  "data": {
    "HeliumBatch": "{\"status\":\"complete\",\"processedItems\":120,\"failedItems\":0}"
  }
}

QueryHeliumDeploymentLog1 pt

Fetch Helium deployment log

Retrieves the event log for a specific Helium deployment job, returning a paginated list of log events along with tokens for forward and backward pagination. Each log event includes a timestamp, ingestion time, and a human-readable message. Use this query to debug deployment issues, audit deployment activity, or stream live log output by repeatedly querying with the `nextForwardToken`. The optional `filters` argument allows narrowing results by time range or other criteria.

Arguments

Name	Type	Required	Description
jobId	ID!	Yes	The unique identifier of the Helium deployment job whose log should be retrieved.
filters	HeliumDeploymentLogFiltersInput	No	Optional filters to narrow the log results, such as restricting events to a specific time range or log level.

Returns

Field	Type	Description
events	[HeliumDeploymentLogEvent!]!	An ordered list of log events for the deployment job, each containing a timestamp, ingestion time, and message.
nextForwardToken	String	A pagination token used to fetch the next page of log events in chronological order. Pass this value as a filter in subsequent requests.
nextBackwardToken	String	A pagination token used to fetch the previous page of log events in reverse chronological order. Pass this value as a filter in subsequent requests.

Example

query HeliumDeploymentLog {
  HeliumDeploymentLog(
    jobId: "job_7tRmX92kLpQn",
    filters: { startTime: "2024-03-01T00:00:00Z", endTime: "2024-03-01T23:59:59Z" }
  ) {
    events {
      timestamp
      message
      ingestionTime
    }
    nextForwardToken
    nextBackwardToken
  }
}

Example Response

{
  "data": {
    "HeliumDeploymentLog": {
      "events": [
        {
          "timestamp": "2024-03-01T10:15:00Z",
          "message": "Deployment started for environment my-learning-portal.",
          "ingestionTime": "2024-03-01T10:15:01Z"
        },
        {
          "timestamp": "2024-03-01T10:15:45Z",
          "message": "Assets compiled successfully. Script hash: sha256-abcdef1234567890.",
          "ingestionTime": "2024-03-01T10:15:46Z"
        },
        {
          "timestamp": "2024-03-01T10:16:30Z",
          "message": "Deployment complete.",
          "ingestionTime": "2024-03-01T10:16:31Z"
        }
      ],
      "nextForwardToken": "fwd_tok_Xk92mNpLqRtVwZy",
      "nextBackwardToken": "bwd_tok_AaBbCcDdEeFfGgHh"
    }
  },
  "events": null,
  "nextForwardToken": "example",
  "nextBackwardToken": "example"
}

QueryHeliumDeploymentStatus1 pt

Fetch Helium deployment status

Returns the current status of a Helium deployment job as a string. Supply the required `jobId` to identify the deployment, and optionally provide a `key`, `atomsScriptHash`, and/or `atomsStyleHash` to scope or validate the status check against specific deployment artifacts. This query is useful for polling the progress of an ongoing deployment or verifying that a deployment's compiled assets match expected hash values.

Arguments

Name	Type	Required	Description
jobId	ID!	Yes	The unique identifier of the Helium deployment job whose status should be retrieved.
key	String	No	An optional deployment key used to scope the status check to a specific Helium environment or session.
atomsScriptHash	String	No	An optional hash of the compiled Atoms JavaScript bundle, used to verify that the deployed script artifact matches the expected version.
atomsStyleHash	String	No	An optional hash of the compiled Atoms CSS stylesheet bundle, used to verify that the deployed style artifact matches the expected version.

Returns

Field	Type	Description
HeliumDeploymentStatus	String!	A string representing the current status of the deployment job (e.g., PENDING, IN_PROGRESS, COMPLETE, FAILED).

Example

query HeliumDeploymentStatus {
  HeliumDeploymentStatus(
    jobId: "job_7tRmX92kLpQn",
    key: "hlm_k9f2x7qzLmNpRtVw",
    atomsScriptHash: "sha256-abcdef1234567890",
    atomsStyleHash: "sha256-09876fedcba54321"
  )
}

Example Response

{
  "data": {
    "HeliumDeploymentStatus": "IN_PROGRESS"
  }
}

QueryHeliumLaunchData1 pt

Fetch Helium launch data

Retrieves the launch credentials needed to initialize a Helium front-end experience for a given site or environment identified by its nickname. The response includes a signing key and a signed URL that can be used to bootstrap the Helium runtime. Use this query at application startup or when rendering a Helium-powered page to obtain fresh, signed access details.

Arguments

Name	Type	Required	Description
nickname	String!	Yes	The short name or slug that identifies the Helium-enabled site or environment to launch.

Returns

Field	Type	Description
key	String!	A unique key identifying this Helium deployment or session, used in subsequent Helium API calls.
signedUrl	AbsoluteOrRelativeURL!	A signed URL used to bootstrap or launch the Helium front-end experience. May be absolute or relative.

Example

query HeliumLaunchData {
  HeliumLaunchData(nickname: "my-learning-portal") {
    key
    signedUrl
  }
}

Example Response

{
  "data": {
    "HeliumLaunchData": {
      "key": "hlm_k9f2x7qzLmNpRtVw",
      "signedUrl": "https://cdn.example.com/helium/my-learning-portal/launch?sig=abc123xyz&expires=1710000000"
    }
  },
  "key": "example",
  "signedUrl": "example"
}