Skip to main content
API docs by Redocly

Signaloid Cloud Compute Engine API (1.0.0)

Download OpenAPI specification:Download

Signaloid Developer Support: developer-support@signaloid.com Terms of Service

This is the Signaloid Cloud Compute Engine API OpenAPI specification. Signaloid provides a computing platform to quantify, transmit, and track data uncertainty dynamically and throughout computations in unmodified computing workloads. The Signaloid Cloud Compute Engine API enables you to interface with the Signaloid Cloud Compute Engine programmatically.

Authentication

The Signaloid Cloud Compute Engine API currently offers authentication using API keys. Authentication is required for all API requests and the request must include the API key it in the Authentication header. Read more about how to obtain a API key in the Authentication guide.

API Versioning

The Signaloid Cloud Compute Engine API is in beta. We make every effort to maintain backwards compatibility, but we reserve the right to make breaking changes to the API while still in beta. We will announce breaking changes in the Signaloid Cloud Platform Release Notes.

API Guides

The current page is the API reference. For more information about how to use the Signaloid Cloud API in your application and combine different requests, see the API Guides.

Cores

List Cores

Returns the list of custom Signaloid cores available to the account. The response does not include the default cores available to all accounts.

Authorizations:
ApiKey
query Parameters
default
boolean

By default this API will return your custom cores. By providing this parameter you will get back the default cores, created and managed by Signaloid for you.

Responses

Response samples

Content type
application/json
{
  • "UserID": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
  • "Count": 3,
  • "ContinuationKey": "cor_051481609fe04665b576ab066e378257",
  • "Cores": [
    ]
}

Create Core

Creates a new custom Signaloid Core. The new Core becomes available to the account and is returned in the response.

Authorizations:
ApiKey
Request Body schema: application/json
Name
required
string non-empty
Class
required
string
Enum: "C0" "C0Pro"
Precision
required
integer [ 4 .. 1000000 ]

The precision of the core. The minimum value is 4. The maximum value is 8000 for the Athens and Zurich Microarchitectures, and 1000000 (1M) for the Reference Microarchitecture.

MemorySize
required
integer [ 256000 .. 4000000000 ]
Microarchitecture
required
string (Microarchitecture)
Enum: "Zurich" "Athens" "Bypass" "Reference"
CorrelationTracking
required
string (CorrelationTracking)
Enum: "Autocorrelation" "Disable"

The value is case-insensitive.

Responses

Request samples

Content type
application/json
{
  • "Name": "My New Custom Core",
  • "Class": "C0",
  • "Microarchitecture": "Athens",
  • "CorrelationTracking": "autocorrelation",
  • "MemorySize": 256000,
  • "Precision": 128
}

Response samples

Content type
application/json
{
  • "Object": "Core",
  • "CoreID": "cor_3ff9395ee9494f3d91a8e1b5999d737e",
  • "Owner": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
  • "CreatedAt": 1677025457,
  • "UpdatedAt": 1677025457,
  • "Name": "My New Custom Core",
  • "Class": "C0",
  • "Microarchitecture": "Athens",
  • "CorrelationTracking": "autocorrelation",
  • "MemorySize": 256000,
  • "Precision": 128
}

Get Core

Returns the custom Signaloid core identified by the CoreID path parameter.

Authorizations:
ApiKey
path Parameters
CoreID
required
string (CoreID) cor_[a-z0-9]{32}

The identifier of the Core resource.

Responses

Response samples

Content type
application/json
{
  • "Object": "Core",
  • "CoreID": "string",
  • "Owner": "string",
  • "Name": "string",
  • "Class": "C0",
  • "Precision": 4,
  • "Microarchitecture": "Zurich",
  • "MemorySize": 0,
  • "CorrelationTracking": "Autocorrelation",
  • "CreatedAt": 0,
  • "UpdatedAt": 0
}

Delete Core

Permanently deletes the custom Signaloid core identified by the CoreID parameter.

Authorizations:
ApiKey
path Parameters
CoreID
required
string (CoreID) cor_[a-z0-9]{32}

The identifier of the Core resource.

Responses

Response samples

Content type
application/json
{
  • "message": "OK"
}

Update Core

Updates the custom Signaloid core identified by the CoreID parameter. This method is useful for updating the core of a specific CoreID without having to edit integrations that use this core. The request must change at least one of the editable Core properties for the Signaloid Cloud API to accept it. The response is the edited core.

Authorizations:
ApiKey
path Parameters
CoreID
required
string (CoreID) cor_[a-z0-9]{32}

The identifier of the Core resource.

Request Body schema: application/json
Name
required
string non-empty
Class
required
string
Enum: "C0" "C0Pro"
Precision
required
integer [ 4 .. 1000000 ]

The precision of the core. The minimum value is 4. The maximum value is 8000 for the Athens and Zurich Microarchitectures, and 1000000 (1M) for the Reference Microarchitecture.

MemorySize
required
integer [ 256000 .. 4000000000 ]
Microarchitecture
required
string (Microarchitecture)
Enum: "Zurich" "Athens" "Bypass" "Reference"
CorrelationTracking
required
string (CorrelationTracking)
Enum: "Autocorrelation" "Disable"

The value is case-insensitive.

Responses

Request samples

Content type
application/json
{
  • "Name": "string",
  • "Class": "C0",
  • "Precision": 4,
  • "MemorySize": 256000,
  • "Microarchitecture": "Zurich",
  • "CorrelationTracking": "Autocorrelation"
}

Response samples

Content type
application/json
{
  • "message": "OK"
}

Repositories

List connected repositories

Returns the list of git repositories available to the account.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "UserID": "string",
  • "Repositories": [
    ],
  • "Count": 0,
  • "ContinuationKey": "string"
}

Connect a Repository

Creates a new connection to a git repository. The request must contain the URL of the repository, commit, branch, and build directory. The response is the created connected repository resource.

Authorizations:
ApiKey
Request Body schema: application/json
RemoteURL
required
string <uri>

The URL of the git repository.

Commit
required
string

The commit hash to check out.

Branch
required
string

The branch name to check out.

BuildDirectory
required
string

The directory in the repository where the Signaloid Cloud Engine should use as working directory when attempting to build the repository application. This directory is relative to the root of the repository.

Arguments
string

Default command-line arguments that the Signaloid Cloud Engine should pass when executing the built repository application.

Core
string (CoreID) cor_[a-z0-9]{32}
Array of objects (DataSources) [ items [ 0 .. 5 ] items ]
Array
Location
required
string
ResourceID
required
string
ResourceType
required
string (resourceType)
Enum: "Gateway" "Bucket" "Drive" "SignaloidCloudStorage"
Array of objects (TraceVariableRequest)

The default variables that the Signaloid Cloud Compute Engine should trace when executing the Repository application.

Array
File
required
string
LineNumber
required
integer >= 0
Expression
required
string

The expression to trace. E.g., x[0]. To learn more about tracing expressions, see the Tracing Variables section in the API Guides.

Responses

Request samples

Content type
application/json
{
  • "RemoteURL": "http://example.com",
  • "Commit": "string",
  • "Branch": "string",
  • "BuildDirectory": "string",
  • "Arguments": "string",
  • "Core": "string",
  • "DataSources": [
    ],
  • "TraceVariables": [
    ]
}

Response samples

Content type
application/json
{
  • "Object": "Repository",
  • "RepositoryID": "string",
  • "Owner": "string",
  • "RemoteURL": "http://example.com",
  • "Commit": "string",
  • "Branch": "string",
  • "BuildDirectory": "string",
  • "Arguments": "string",
  • "Core": "string",
  • "DataSources": [
    ],
  • "TraceVariables": [
    ],
  • "CreatedAt": 0,
  • "UpdatedAt": 0
}

Get Repository

Returns the connected git repository resource identified by the RepositoryID parameter.

Authorizations:
ApiKey
path Parameters
RepositoryID
required
string (RepositoryID) rep_[a-z0-9]{32}

The identifier of the connected Repository resource.

Responses

Response samples

Content type
application/json
{
  • "Object": "Repository",
  • "RepositoryID": "string",
  • "Owner": "string",
  • "RemoteURL": "http://example.com",
  • "Commit": "string",
  • "Branch": "string",
  • "BuildDirectory": "string",
  • "Arguments": "string",
  • "Core": "string",
  • "DataSources": [
    ],
  • "TraceVariables": [
    ],
  • "CreatedAt": 0,
  • "UpdatedAt": 0
}

Delete Repository

Permanently deletes the connected git repository resource identified by the RepositoryID parameter.

Authorizations:
ApiKey
path Parameters
RepositoryID
required
string (RepositoryID) rep_[a-z0-9]{32}

The identifier of the connected Repository resource.

Responses

Response samples

Content type
application/json
{
  • "message": "OK"
}

Update Repository

Updates the connected git repository resource identified by the RepositoryID parameter. This method is useful for updating the connected repository resource of a specific RepositoryID (e.g., to change the branch it points at) without having to edit integrations that use this repository. The request must change at least one of the editable repository properties for the Signaloid Cloud API to accept it. The response is the edited repository resource.

Authorizations:
ApiKey
path Parameters
RepositoryID
required
string (RepositoryID) rep_[a-z0-9]{32}

The identifier of the connected Repository resource.

Request Body schema: application/json
RemoteURL
string <uri>
Commit
string
Branch
string
BuildDirectory
string

The directory in the repository where the Signaloid Cloud Engine should use as working directory when attempting to build the repository application. This directory is relative to the root of the repository.

Arguments
string

Default command-line arguments that the Signaloid Cloud Engine should pass when executing the built repository application.

Core
string (CoreID) cor_[a-z0-9]{32}
Array of objects (DataSources) [ items [ 0 .. 5 ] items ]
Array
Location
required
string
ResourceID
required
string
ResourceType
required
string (resourceType)
Enum: "Gateway" "Bucket" "Drive" "SignaloidCloudStorage"
Array of objects (TraceVariableRequest)

The default variables that the Signaloid Cloud Compute Engine should trace when executing the Repository application.

Array
File
required
string
LineNumber
required
integer >= 0
Expression
required
string

The expression to trace. E.g., x[0]. To learn more about tracing expressions, see the Tracing Variables section in the API Guides.

Responses

Request samples

Content type
application/json
{
  • "RemoteURL": "http://example.com",
  • "Commit": "string",
  • "Branch": "string",
  • "BuildDirectory": "string",
  • "Arguments": "string",
  • "Core": "string",
  • "DataSources": [
    ],
  • "TraceVariables": [
    ]
}

Response samples

Content type
application/json
{
  • "Object": "Repository",
  • "RepositoryID": "string",
  • "Owner": "string",
  • "RemoteURL": "http://example.com",
  • "Commit": "string",
  • "Branch": "string",
  • "BuildDirectory": "string",
  • "Arguments": "string",
  • "Core": "string",
  • "DataSources": [
    ],
  • "TraceVariables": [
    ],
  • "CreatedAt": 0,
  • "UpdatedAt": 0
}

Create Build from Repository

Creates a new build from the specified repository.

Authorizations:
ApiKey
path Parameters
RepositoryID
required
string (RepositoryID) rep_[a-z0-9]{32}

The identifier of the connected Repository resource.

query Parameters
DiscoverVariables
string
Enum: "true" "false"

If set to "true", the build will attempt to discover variables that can be traced.

Request Body schema: application/json
CoreID
string (CoreID) cor_[a-z0-9]{32}
Array of objects (TraceVariableRequest)

Variables to trace in the built application. If not provided, will use the repository's defaults.

Array
File
required
string
LineNumber
required
integer >= 0
Expression
required
string

The expression to trace. E.g., x[0]. To learn more about tracing expressions, see the Tracing Variables section in the API Guides.

Array of objects (DataSources) [ items [ 0 .. 5 ] items ]
Array
Location
required
string
ResourceID
required
string
ResourceType
required
string (resourceType)
Enum: "Gateway" "Bucket" "Drive" "SignaloidCloudStorage"
Arguments
string

Command-line arguments to pass to the application. If not provided, will use the repository's defaults.

Responses

Request samples

Content type
application/json
{
  • "CoreID": "string",
  • "TraceVariables": [
    ],
  • "DataSources": [
    ],
  • "Arguments": "string"
}

Response samples

Content type
application/json
{
  • "BuildID": "string"
}

Builds

Create Build from Repository

Creates a new build from the specified repository.

Authorizations:
ApiKey
path Parameters
RepositoryID
required
string (RepositoryID) rep_[a-z0-9]{32}

The identifier of the connected Repository resource.

query Parameters
DiscoverVariables
string
Enum: "true" "false"

If set to "true", the build will attempt to discover variables that can be traced.

Request Body schema: application/json
CoreID
string (CoreID) cor_[a-z0-9]{32}
Array of objects (TraceVariableRequest)

Variables to trace in the built application. If not provided, will use the repository's defaults.

Array
File
required
string
LineNumber
required
integer >= 0
Expression
required
string

The expression to trace. E.g., x[0]. To learn more about tracing expressions, see the Tracing Variables section in the API Guides.

Array of objects (DataSources) [ items [ 0 .. 5 ] items ]
Array
Location
required
string
ResourceID
required
string
ResourceType
required
string (resourceType)
Enum: "Gateway" "Bucket" "Drive" "SignaloidCloudStorage"
Arguments
string

Command-line arguments to pass to the application. If not provided, will use the repository's defaults.

Responses

Request samples

Content type
application/json
{
  • "CoreID": "string",
  • "TraceVariables": [
    ],
  • "DataSources": [
    ],
  • "Arguments": "string"
}

Response samples

Content type
application/json
{
  • "BuildID": "string"
}

List Builds

Returns the list of builds.

Authorizations:
ApiKey
query Parameters
startKey
string

The BuildID to start from when returning the list of builds. Used for paginating responses.

from
string <date-time>

Filter builds by creation date - only include builds created on or after this date.

to
string <date-time>

Filter builds by creation date - only include builds created on or before this date.

status
string (BuildStatus)
Enum: "Accepted" "Initialising" "Rescheduled" "In Progress" "Completed" "Cancelled" "Stopped"

Filter the list of builds by status.

Responses

Response samples

Content type
application/json
{
  • "UserID": "string",
  • "Builds": [
    ],
  • "Count": 0,
  • "ContinuationKey": "string"
}

Get Build

Returns the build resource identified by the BuildID path parameter.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Responses

Response samples

Content type
application/json
{
  • "BuildID": "string",
  • "Owner": "string",
  • "Status": "Accepted",
  • "StatusTransitions": [
    ],
  • "StartedAt": 0,
  • "DefaultArguments": "string",
  • "DefaultDataSources": [
    ],
  • "Application": {
    },
  • "UpdatedAt": 0,
  • "CreatedAt": 0,
  • "FinishedAt": 0,
  • "BuildArtifactAvailable": true,
  • "BuildCoreSpecs": {
    },
  • "TraceVariables": [
    ],
  • "Stats": {
    }
}

Delete Build

Permanently deletes the build asset identified by the BuildID path parameter. This operation cannot be performed on active builds.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "message": "string"
}

Get Build Binary

Returns a pre-signed URL to download the binary artifact for the build identified by the BuildID path parameter. This is only available for builds with C0-microSD core class.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Responses

Response samples

Content type
application/json
{}

Get Build Outputs

Returns URLs to the output files associated with the build.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Responses

Response samples

Content type
application/json
{
  • "Build": "string"
}

Get Build Variables

Returns the list of variables discovered in the build.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

query Parameters
startKey
string

The key to start from when returning the list of variables. Used for paginating responses.

Responses

Response samples

Content type
application/json
{
  • "BuildID": "string",
  • "Variables": [
    ],
  • "Count": 0,
  • "ContinuationKey": "string"
}

Cancel Build

Cancels an active build identified by the BuildID path parameter.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Responses

Response samples

Content type
application/json
{
  • "Message": "Cancel Build Signal sent"
}

List Build Tasks

Returns the list of tasks associated with the specified build.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

query Parameters
startKey
string

The key to start from when returning the list of tasks. Used for paginating responses.

from
string <date-time>

Filter tasks by creation date - only include tasks created on or after this date.

to
string <date-time>

Filter tasks by creation date - only include tasks created on or before this date.

Responses

Response samples

Content type
application/json
{
  • "BuildID": "string",
  • "Tasks": [
    ],
  • "Count": 0,
  • "ContinuationKey": "string"
}

Create Task from Build

Creates a new task using the specified build.

Authorizations:
ApiKey
path Parameters
BuildID
required
string (BuildID) bld_[a-z0-9]{32}

The identifier of the Build resource.

Request Body schema: application/json
Arguments
string

Command-line arguments to pass to the application.

Array of objects (DataSources) [ items [ 0 .. 5 ] items ]
Array
Location
required
string
ResourceID
required
string
ResourceType
required
string (resourceType)
Enum: "Gateway" "Bucket" "Drive" "SignaloidCloudStorage"

Responses

Request samples

Content type
application/json
{
  • "Arguments": "string",
  • "DataSources": [
    ]
}

Response samples

Content type
application/json
{
  • "TaskID": "string"
}

Create Build From Single-file Source Code

Creates a new build from a single-file source code. The source code is compiled and built using the specified core.

Authorizations:
ApiKey
query Parameters
DiscoverVariables
string
Enum: "true" "false"

If set to "true", the build will attempt to discover variables that can be traced.

Request Body schema: application/json
Code
required
string

The source code to build. Can be provided as plain text or Base64 encoded.

Language
required
string
Enum: "C" "C++" "Fortran"

The programming language of the source code.

CoreID
string

The ID of the core to use for building. If not provided, a default core will be used.

Array of objects (TraceVariableRequest)
Array
File
required
string
LineNumber
required
integer >= 0
Expression
required
string

The expression to trace. E.g., x[0]. To learn more about tracing expressions, see the Tracing Variables section in the API Guides.

Responses

Request samples

Content type
application/json
{
  • "Code": "string",
  • "Language": "C",
  • "CoreID": "string",
  • "TraceVariables": [
    ]
}

Response samples

Content type
application/json
{
  • "BuildID": "string"
}

Tasks

List Tasks

Returns the list of Tasks in the account. The list is sorted by field CreatedAt in descending order. To learn more about Tasks, see the Tasks section in the Signaloid Cloud Platform Documentation.

Authorizations:
ApiKey
query Parameters
status
string (TaskStatus)
Enum: "Accepted" "Initialising" "Rescheduled" "In Progress" "Completed" "Cancelled" "Stopped"

Filter the list of Tasks by status. Required to expand Tasks. By default the list includes all Tasks. To filter the list by status set the status query parameter to a valid Status value.

startKey
string (TaskID) tsk_[a-z0-9]{32}

The TaskID to start from when returning the list of Tasks. Use for paginating responses.

from
string <date-time>

Filter tasks by creation date - only include tasks created on or after this date.

to
string <date-time>

Filter tasks by creation date - only include tasks created on or before this date.

Responses

Response samples

Content type
application/json
{
  • "UserID": "string",
  • "Count": 0,
  • "ContinuationKey": "string",
  • "Tasks": [
    ]
}

Get Task

Returns the Task resource identified by the TaskID path parameter. To learn more about Tasks, see the Tasks section in the Signaloid Cloud Developer Platform Documentation.

Authorizations:
ApiKey
path Parameters
TaskID
required
string (TaskID) tsk_[a-z0-9]{32}

The identifier of the Task resource.

Responses

Response samples

Content type
application/json
{
  • "TaskID": "string",
  • "BuildID": "string",
  • "Owner": "string",
  • "Status": "Accepted",
  • "StatusTransitions": [
    ],
  • "Arguments": "string",
  • "DataSources": [
    ],
  • "StartedAt": 0,
  • "UpdatedAt": 0,
  • "CreatedAt": 0,
  • "FinishedAt": 0,
  • "Stats": {
    }
}

Delete Task

Permanently deletes the Task identified by the TaskID path parameter. This operation cannot be performed on active tasks.

Authorizations:
ApiKey
path Parameters
TaskID
required
string (TaskID) tsk_[a-z0-9]{32}

The identifier of the Task resource.

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "message": "string"
}

Cancel Task

Cancels the active Task identified by the TaskID path parameter.

Authorizations:
ApiKey
path Parameters
TaskID
required
string (TaskID) tsk_[a-z0-9]{32}

The identifier of the Task resource.

Responses

Response samples

Content type
application/json
{
  • "Message": "Cancel Task Signal sent"
}

Get Task Outputs

Returns URLs to the output files associated with the task.

Authorizations:
ApiKey
path Parameters
TaskID
required
string (TaskID) tsk_[a-z0-9]{32}

The identifier of the Task resource.

Responses

Response samples

Content type
application/json
{
  • "Stdout": "string",
  • "Stderr": "string",
  • "StdoutChunks": [
    ]
}

Get Task Stream Output

Returns the requested output (Stdout or Stderr) for a specific task. Returns the plain text output, or a redirect to a download URL if output is larger than 5 MB. Optional query param to skip cache.

Authorizations:
ApiKey
path Parameters
TaskID
required
string

Task ID

Stream
required
string

Output stream (Stdout or Stderr)

query Parameters
skipCache
boolean

If true, bypass cache

Responses

Response samples

Content type
"string"

Samples

List of generated samples in Reference Core runs

Returns the list of samples that were generated for the provided ValueID during the Reference Core task with the provided TaskID. In Reference Core Tasks, the Value identifiers (ValueID) are part of the standard output streams.

Authorizations:
ApiKey
path Parameters
TaskID
required
string (TaskID) tsk_[a-z0-9]{32}

The identifier of the Task resource.

ValueID
required
string (valueID) val_[a-z0-9]{32}

The identifier of the Value resource.

query Parameters
count
integer [ 0 .. 100000 ]
Default: 1000

By default this API will return up to 1000 samples. By providing this parameter you can specify the number of samples returned. This parameter has a maximum limit of 100000.

Responses

Response samples

Content type
application/json
{
  • "Samples": [
    ],
  • "Count": 32
}

Random samples from hexadecimal ("Ux") data

Returns a list of random samples from the provided Hexadecimal ("Ux") Data Format (Ux string). In non-Reference Core Tasks, distributions encoded as Ux strings are part of the standard output streams."

Authorizations:
ApiKey
query Parameters
count
integer [ 0 .. 100000 ]
Default: 1000

By default this API will return up to 1000 samples. By providing this parameter you can specify the number of samples returned. This parameter has a maximum limit of 100000.

Request Body schema: application/json
payload
required
string

Responses

Request samples

Content type
application/json
{
  • "payload": "string"
}

Response samples

Content type
application/json
{
  • "Samples": [
    ],
  • "Count": 32
}

Plots

Plot Value ID

Plot a Reference Core run output value identified by the TaskID and ValueID query parameters. Returns a PlotID and a direct URL that can be used to retrieve the plot image.

Authorizations:
ApiKey
query Parameters
taskID
required
string (taskID) tsk_[a-z0-9]{32}

task ID

valueID
required
string (valueID) val_[a-z0-9]{32}

value ID

Responses

Response samples

Content type
application/json
{}

Plot Ux String

Plot a Laplace Core run Ux string by passing into the body of the request. Returns a PlotID and a direct URL that can be used to retrieve the plot image.

Authorizations:
ApiKey
Request Body schema: application/json
payload
required
string

Responses

Request samples

Content type
application/json
{
  • "payload": "string"
}

Response samples

Content type
application/json
{}

Cloud Storage

List Files or Directories

Authorizations:
ApiKey
query Parameters
path
string

Directory to list. Defaults to the root directory (/) for the authenticated user.

startKey
string

Continuation token for paginated results.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "nextContinuationToken": "string"
}

Download a file or list a directory

Authorizations:
ApiKey
path Parameters
path
required
string

The relative path to the file or directory.

query Parameters
download
boolean

If provided, downloads the specified file.

Responses

Response samples

Content type
application/json
Example
{
  • "count": 6,
  • "items": [
    ]
}

Upload a file or create a directory

Authorizations:
ApiKey
path Parameters
path
required
string

The relative path where the file or directory will be created.

query Parameters
directory
boolean

If provided, creates a directory at the specified path.

size
integer

The size of the file to be uploaded, in bytes. Required for file uploads.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "upload_url": "string"
}

Delete a file or directory

Authorizations:
ApiKey
path Parameters
path
required
string

The relative path to the file or directory to delete.

query Parameters
recursive
boolean

If provided, deletes directories and their contents recursively. Valid only for directories.

directory
boolean

If provided, specifies that the path refers to a directory.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Health

Get system health status

Returns the health status of Signaloid Cloud services.

The health check system monitors:

  • Signaloid Cloud Developer Platform (SCDP)
  • Signaloid Cloud Compute Engine (SCCE) API
  • SCCE Compute Engine
  • SCCE Build Engine
Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2025-05-16T13:55:25.605Z",
  • "services": [
    ]
}

Webhooks

Create a new webhook

Creates a new webhook endpoint for receiving event notifications.

Available Webhook Events

The infrastructure API supports webhook notifications for the following events:

1. Task Status Changed (task-status)

Triggered when a task's status changes through any of these states:

  • Initializing - Task is being set up
  • In Progress - Task is actively running
  • Completed - Task finished successfully
  • Cancelled - Task was cancelled by user
  • Stopped - Task was stopped by system
  • Failed - Task encountered an error

Payload includes: taskId, status, message, and updatedAt.

2. Build Status Changed (build-status)

Triggered when a build's status changes through any of these states:

  • Initializing - Build is being set up
  • In Progress - Build is actively running
  • Completed - Build finished successfully
  • Cancelled - Build was cancelled by user
  • Stopped - Build was stopped by system
  • Failed - Build encountered an error

Payload includes: buildId, status, message, and updatedAt.

3. Task Count Changed (task-count)

Triggered when a user's task count changes (tasks created or completed).

Payload includes: userId, IncrementTaskCount, and DecrementTaskCount.

4. Build Count Changed (build-count)

Triggered when a user's build count changes (builds created or completed).

Payload includes: userId, IncrementBuildCount, and DecrementBuildCount.

5. Task Stats Changed (task-stats)

Triggered when a user's task execution stats are updated.

Payload includes: userId, TotalDynamicInstructions, and TotalExecutionTime.

6. Build Stats Changed (build-stats)

Triggered when a user's build stats are updated.

Payload includes: userId, TotalBuildSize, and TotalBuildTime.

Webhook Payload Structure

All webhook payloads follow this consistent structure:

{
  "version": "1.0",
  "eventType": "task-status|build-status|task-count|build-count|task-stats|build-stats",
  "userId": "usr_[32-char-alphanumeric]",
  "timestamp": "2024-03-20T10:00:00Z",
  "data": {
    // Event-specific data varies by event type
  }
}

Security

  • All webhooks include a signature header for verification
  • Webhooks support retry logic for failed deliveries
  • Rate limiting applies to webhook deliveries
Authorizations:
ApiKey
Request Body schema: application/json
url
required
string <uri>

The URL where webhook events will be sent

events
required
Array of strings
Items Enum: "task-status" "build-status" "task-stats" "build-stats" "task-count" "build-count"

List of events to subscribe to

description
string

Optional description of the webhook

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "WebhookID": "wh-1234567890abcdef1234567890abcdef",
  • "URL": "https://webhook.site/1406bd34-bd36-4e83-8341-90d0bcec5b13",
  • "Events": [
    ],
  • "Description": "Test webhook",
  • "Status": "active",
  • "Secret": "whsec_1234567890abcdef1234567890abcdef",
  • "CreatedAt": "2025-05-19T16:37:44.962Z",
  • "UpdatedAt": "2025-05-19T16:37:44.962Z",
  • "FailureCount": 0,
  • "LastDeliveryStatus": null,
  • "LastDeliveryTime": null,
  • "Object": "webhook"
}

List all webhooks

Retrieves a list of all webhooks for the authenticated user

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ],
  • "count": 4
}

Get a webhook

Retrieves details of a specific webhook.

Authorizations:
ApiKey
path Parameters
WebhookID
required
string

The webhook ID

Responses

Response samples

Content type
application/json
{
  • "WebhookID": "wh-1234567890abcdef1234567890abcdef",
  • "URL": "https://webhook.site/1406bd34-bd36-4e83-8341-90d0bcec5b13",
  • "Events": [
    ],
  • "Description": "Test webhook",
  • "Status": "active",
  • "Secret": "whsec_1234567890abcdef1234567890abcdef",
  • "CreatedAt": "2025-05-19T16:37:44.962Z",
  • "UpdatedAt": "2025-05-19T16:37:44.962Z",
  • "FailureCount": 0,
  • "LastDeliveryStatus": null,
  • "LastDeliveryTime": null,
  • "Object": "webhook"
}

Update a webhook

Updates the configuration of an existing webhook.

Authorizations:
ApiKey
path Parameters
WebhookID
required
string

The webhook ID

Request Body schema: application/json
url
string <uri>
events
Array of strings
Items Enum: "task-status" "build-status" "task-stats" "build-stats" "task-count" "build-count"
description
string
status
string
Enum: "active" "disabled"

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "WebhookID": "wh-1234567890abcdef1234567890abcdef",
  • "URL": "https://webhook.site/1406bd34-bd36-4e83-8341-90d0bcec5b13",
  • "Events": [
    ],
  • "Description": "Test webhook",
  • "Status": "active",
  • "Secret": "whsec_1234567890abcdef1234567890abcdef",
  • "CreatedAt": "2025-05-19T16:37:44.962Z",
  • "UpdatedAt": "2025-05-19T16:37:44.962Z",
  • "FailureCount": 0,
  • "LastDeliveryStatus": null,
  • "LastDeliveryTime": null,
  • "Object": "webhook"
}

Delete a webhook

Deletes a webhook endpoint.

Authorizations:
ApiKey
path Parameters
WebhookID
required
string

The webhook ID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthorized",
  • "message": "Not authorized request."
}

WebSockets

WebSocket connection endpoint for real-time events

AWS AppSync Event API endpoint for WebSocket connections to receive real-time events. This is a WebSocket-only endpoint that supports both JWT and API Key authentication.

Available Channels

The infrastructure API supports real-time events through the following channels:

1. Build Status (build-status/{userId})

Notifies about build lifecycle state changes:

  • Accepted - Build request has been accepted
  • Initializing - Build environment is being set up
  • In Progress - Build is actively running
  • Rescheduled - Build has been rescheduled
  • Completed - Build finished successfully
  • Cancelled - Build was cancelled by user
  • Stopped - Build was stopped by system

Payload includes: buildId, status, message, and timestamp.

2. Task Status (task-status/{userId})

Notifies about task lifecycle state changes:

  • Accepted - Task request has been accepted
  • Initializing - Task environment is being set up
  • In Progress - Task is actively running
  • Rescheduled - Task has been rescheduled
  • Completed - Task finished successfully
  • Cancelled - Task was cancelled by user
  • Stopped - Task was stopped by system

Payload includes: taskId, status, message, and timestamp.

3. Build Stats (build-stats/{userId})

Provides build stats updates:

  • TotalBuildSize - Size of the build in bytes
  • TotalBuildTime - Total build time in seconds

Payload includes: buildId, TotalBuildSize, and TotalBuildTime.

4. Task Stats (task-stats/{userId})

Provides task stats updates:

  • TotalDynamicInstructions - Number of dynamic instructions executed
  • TotalExecutionTime - Total execution time in milliseconds

Payload includes: taskId, TotalDynamicInstructions, and TotalExecutionTime.

5. Build Count (build-count/{userId})

Updates about build count changes:

  • IncrementBuildCount - Number of builds added
  • DecrementBuildCount - Number of builds removed

Payload includes: userId, IncrementBuildCount, and DecrementBuildCount.

6. Task Count (task-count/{userId})

Updates about task count changes:

  • IncrementTaskCount - Number of tasks added
  • DecrementTaskCount - Number of tasks removed

Payload includes: userId, IncrementTaskCount, and DecrementTaskCount.

Channel ID Helper

Use the following helper function to extract the correct portion of IDs:

function idToChannel(signaloidUserId) {
    return id.split("_")[1];
}

Connection Protocol

  1. Connect with authorization header
  2. Send connection_init message
  3. Receive connection_ack
  4. Subscribe to channels

Authentication

The WebSocket endpoint must be configured with a valid API key or JWT token. All messages are signed for verification.

Message Structure

All WebSocket messages follow this consistent structure:

{
  "type": "connection_init|connection_ack|subscribe|subscribe_success|data|error|ka",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "builds/bld_123/status",
  "payload": {
    // Channel-specific data varies by event type
  }
}
Authorizations:
NoneNone
header Parameters
Authorization
required
string

Base64 URL encoded authorization header. Format: { "host": "your-appsync-domain", "authorization": "Bearer " or "scce_" }

Sec-WebSocket-Protocol
required
string

WebSocket protocol header. Must include:

  • header-{base64_encoded_auth}
  • aws-appsync-event-ws

Responses

Response samples

Content type
application/json
Example
{
  • "type": "connection_init"
}