Signaloid Cloud Compute Engine API (0.8.0)
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.
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.
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.
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.
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:
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
- 200
- 500
{- "UserID": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
- "Count": 3,
- "ContinuationKey": "cor_051481609fe04665b576ab066e378257",
- "Cores": [
- {
- "Object": "Core",
- "CoreID": "cor_051481609fe04665b576ab066e378257",
- "Owner": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
- "CreatedAt": 1670405103,
- "UpdatedAt": 1670405103,
- "Name": "My Custom Athens Core",
- "Class": "C0",
- "Microarchitecture": "Athens",
- "CorrelationTracking": "disable",
- "MemorySize": 2000000,
- "Precision": 32
}, - {
- "Object": "Core",
- "CoreID": "cor_3c336f8d8dd343a2b91ca278de0ba32c",
- "Owner": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
- "CreatedAt": 1669821723,
- "UpdatedAt": 1669908393,
- "Name": "Custom Reference Core",
- "Class": "C0",
- "Microarchitecture": "Reference",
- "CorrelationTracking": "disable",
- "MemorySize": 32000000,
- "Precision": 8
}, - {
- "Object": "Core",
- "CoreID": "cor_cd6071a8c67f4a8caad3a8950417d703",
- "Owner": "usr_b0bf834b1ec54d6cb332cc1300efdcba",
- "CreatedAt": 1669822394,
- "UpdatedAt": 1669822394,
- "Name": "Enceladus",
- "Class": "C0",
- "Microarchitecture": "Athens",
- "CorrelationTracking": "autocorrelation",
- "MemorySize": 2000000,
- "Precision": 512
}
]
}
Create Core
Creates a new custom Signaloid Core. The new Core becomes available to the account and is returned in the response.
Authorizations:
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
- Payload
{- "Name": "My New Custom Core",
- "Class": "C0",
- "Microarchitecture": "Athens",
- "CorrelationTracking": "autocorrelation",
- "MemorySize": 256000,
- "Precision": 128
}
Response samples
- 201
- 500
{- "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:
path Parameters
CoreID required | string (CoreID) cor_[a-z0-9]{32} The identifier of the Core resource. |
Responses
Response samples
- 200
- 404
- 500
{- "Object": "Core",
- "CoreID": "string",
- "Owner": "string",
- "Name": "string",
- "Class": "C0",
- "Precision": 4,
- "Microarchitecture": "Zurich",
- "MemorySize": 0,
- "CorrelationTracking": "Autocorrelation",
- "CreatedAt": 0,
- "UpdatedAt": 0
}
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:
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
- Payload
{- "Name": "string",
- "Class": "C0",
- "Precision": 4,
- "MemorySize": 256000,
- "Microarchitecture": "Zurich",
- "CorrelationTracking": "Autocorrelation"
}
Response samples
- 200
- 404
- 500
{- "Object": "Core",
- "CoreID": "string",
- "Owner": "string",
- "Name": "string",
- "Class": "C0",
- "Precision": 4,
- "Microarchitecture": "Zurich",
- "MemorySize": 0,
- "CorrelationTracking": "Autocorrelation",
- "CreatedAt": 0,
- "UpdatedAt": 0
}
List connected repositories
Returns the list of git repositories available to the account.
Authorizations:
Responses
Response samples
- 200
- 500
{- "UserID": "string",
- "Repositories": [
- {
- "Object": "Repository",
- "RepositoryID": "string",
- "Owner": "string",
- "RemoteURL": "string",
- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "CreatedAt": 0,
- "UpdatedAt": 0,
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
], - "Count": 0,
- "ContinuationToken": "string"
}
Connect a Repository
Creates a new connection to a git repository. The request must contain the URL of the repository. The response is the created connected repository resource.
Authorizations:
Request Body schema: application/json
RemoteURL required | string <uri> | ||||||||
Commit required | string | ||||||||
Branch required | string | ||||||||
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 required | 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
| |||||||||
Array of objects (TraceVariableRequest) The default variables that the Signaloid Cloud Compute Engine should trace when executing the Repository application. | |||||||||
Array
|
Responses
Request samples
- Payload
{- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
Response samples
- 201
- 400
- 500
{- "Object": "Repository",
- "RepositoryID": "string",
- "Owner": "string",
- "RemoteURL": "string",
- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "CreatedAt": 0,
- "UpdatedAt": 0,
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
Get Repository
Returns the connected git repository resource identified by the
RepositoryID
parameter.
Authorizations:
path Parameters
RepositoryID required | string (RepositoryID) rep_[a-z0-9]{32} The identifier of the connected Repository resource. |
Responses
Response samples
- 200
- 404
- 500
{- "Object": "Repository",
- "RepositoryID": "string",
- "Owner": "string",
- "RemoteURL": "string",
- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "CreatedAt": 0,
- "UpdatedAt": 0,
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
Delete Repository
Permanently deletes the connected git repository resource identified by
the RepositoryID
parameter.
Authorizations:
path Parameters
RepositoryID required | string (RepositoryID) rep_[a-z0-9]{32} The identifier of the connected Repository resource. |
Responses
Response samples
- 200
- 404
- 500
{- "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:
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
| |||||||||
Array of objects (TraceVariableRequest) The default variables that the Signaloid Cloud Compute Engine should trace when executing the Repository application. | |||||||||
Array
|
Responses
Request samples
- Payload
{- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
Response samples
- 200
- 400
- 404
- 500
{- "Object": "Repository",
- "RepositoryID": "string",
- "Owner": "string",
- "RemoteURL": "string",
- "Commit": "string",
- "Branch": "string",
- "BuildDirectory": "string",
- "Arguments": "string",
- "CreatedAt": 0,
- "UpdatedAt": 0,
- "Core": "string",
- "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
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:
query Parameters
expand | string Value: "Tasks" By default the response is a list of partial-Task objects with only the TaskID and CreatedAt fields. To get the full Task object, set the expand parameter to "Tasks". |
status | string (TaskStatus) Enum: "Accepted" "Initialising" "Building" "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. |
Responses
Response samples
- 200
- 500
{- "UserID": "string",
- "Count": 0,
- "ContinuationKey": "string",
- "Tasks": [
- {
- "Object": "Task",
- "TaskID": "string",
- "Owner": "string",
- "Application": {
- "Type": "SourceCode",
- "SourceCode": {
- "Object": "SourceCode",
- "Code": "string",
- "Language": "C",
- "Arguments": "string"
}, - "Overrides": {
- "Arguments": "string",
- "Core": {
- "Object": "Core",
- "CoreID": "string",
- "Owner": "string",
- "Name": "string",
- "Class": "C0",
- "Precision": 4,
- "Microarchitecture": "Zurich",
- "MemorySize": 0,
- "CorrelationTracking": "Autocorrelation",
- "CreatedAt": 0,
- "UpdatedAt": 0
}, - "DataSources": [
- {
- "Location": "string",
- "Object": "DataSource",
- "ResourceID": "string",
- "ResourceType": "Gateway"
}
], - "TraceVariables": [
- {
- "File": "string",
- "LineNumber": 0,
- "Expression": "string"
}
]
}
}, - "Status": "Accepted",
- "StatusTransitions": [
- {
- "Status": "Accepted",
- "Timestamp": 0,
- "Message": "string"
}
], - "CreatedAt": 0,
- "StartedAt": 0,
- "FinishedAt": 0,
- "UpdatedAt": 0,
- "Stats": {
- "DynamicInstructions": 0,
- "ProcessorTime": 0
}
}
]
}
Create a Task
Creates a new Task and enqueues it in the Signaloid Cloud Compute Engine. To learn more about Tasks, see the Tasks section in the Signaloid Cloud Developer Platform Documentation.
Authorizations:
Request Body schema: application/json
Type required | string Value: "SourceCode" | ||||||||||||||||||||||||||
required | object (SourceCode) | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
required | object (SourceCodeOverrides) | ||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "Type": "Repository",
- "Repository": "rep_d8618faadd62411a9cee1ef0ac91b55f",
- "Overrides": {
- "DataSources": [
- {
- "Object": "DataSource",
- "ResourceID": "signaloid-cloud-storage:/usr_9aca8b0937e14b429f52a0a5ff2dd98d",
- "ResourceType": "SignaloidCloudStorage",
- "Location": "sd0"
}
]
}
}
Response samples
- 202
- 400
- 500
{- "Application": {
- "Type": "Repository",
- "Repository": {
- "UpdatedAt": 1698416094,
- "BuildDirectory": "src",
- "Object": "Repository",
- "RepositoryID": "rep_d8618faadd62411a9cee1ef0ac91b55f",
- "Commit": "HEAD",
- "Owner": "usr_9aca8b0937e14b429f52a0a5ff2dd98d",
- "Branch": "main",
- "Arguments": "",
- "CreatedAt": 1698416093,
- "Core": {
- "UpdatedAt": 1683643245,
- "Class": "C0",
- "Microarchitecture": "Athens",
- "CorrelationTracking": "Autocorrelation",
- "Precision": 64,
- "Object": "Core",
- "MemorySize": 64000000,
- "CoreID": "cor_b21e4de9927158c1a5b603c2affb8a09",
- "Owner": "*",
- "CreatedAt": 1683643245,
- "Name": "C0-S+"
}
}, - "Overrides": {
- "DataSources": [
- {
- "Object": "DataSource",
- "ResourceID": "signaloid-cloud-storage:/usr_9aca8b0937e14b429f52a0a5ff2dd98d",
- "ResourceType": "SignaloidCloudStorage",
- "Location": "sd0"
}
]
}
}, - "Object": "Task",
- "TaskID": "tsk_9a8ec0780a1944559710c6b5da3a0d9a",
- "Owner": "usr_9aca8b0937e14b429f52a0a5ff2dd98d",
- "CreatedAt": 1698416159,
- "UpdatedAt": 1698416159,
- "FinishedAt": 0,
- "StartedAt": 0,
- "Status": "Accepted",
- "StatusTransitions": [
- {
- "Status": "Accepted",
- "Timestamp": 1698416159,
- "Message": "POST /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:
path Parameters
TaskID required | string (TaskID) tsk_[a-z0-9]{32} The identifier of the Task resource. |
Responses
Response samples
- 200
- 404
- 500
{- "Application": {
- "Overrides": {
- "DataSources": [
- {
- "Object": "DataSource",
- "ResourceType": "SignaloidCloudStorage",
- "ResourceID": "signaloid-cloud-storage:/usr_7c13c605135a4dedb5f688ed9921fe64",
- "Location": "sd0"
}
]
}, - "Type": "Repository",
- "Repository": {
- "Owner": "usr_7c13c605135a4dedb5f688ed9921fe64",
- "Commit": "HEAD",
- "BuildDirectory": "src",
- "Branch": "main",
- "CreatedAt": 1723107943,
- "Arguments": "",
- "Object": "Repository",
- "UpdatedAt": 1723107944,
- "RepositoryID": "rep_05cf85f3d8044df8bded5e1d70b1610c",
- "Core": {
- "MemorySize": 64000000,
- "Microarchitecture": "Athens",
- "Owner": "*",
- "CorrelationTracking": "Autocorrelation",
- "Precision": 64,
- "CreatedAt": 1683643245,
- "Class": "C0",
- "Object": "Core",
- "CoreID": "cor_b21e4de9927158c1a5b603c2affb8a09",
- "UpdatedAt": 1683643245,
- "Name": "C0-S+"
}
}
}, - "StatusTransitions": [
- {
- "Status": "Accepted",
- "Message": "POST /tasks",
- "Timestamp": 1723107948
}, - {
- "Message": "Status changed by Signaloid Cloud Computing Engine",
- "Status": "Initialising",
- "Timestamp": 1723107949
}, - {
- "Message": "Status changed by Signaloid Cloud Computing Engine",
- "Status": "Building",
- "Timestamp": 1723107949
}, - {
- "Message": "Status changed by Signaloid Cloud Computing Engine",
- "Status": "In Progress",
- "Timestamp": 1723107950
}, - {
- "Message": "Status changed by Signaloid Cloud Computing Engine",
- "Status": "Completed",
- "Timestamp": 1723107950
}, - {
- "Message": "Status changed by Signaloid Cloud Computing Engine",
- "Status": "Completed",
- "Timestamp": 1723107950
}
], - "UpdatedAt": 1723107950,
- "FinishedAt": 1723107950,
- "Owner": "usr_7c13c605135a4dedb5f688ed9921fe64",
- "Object": "Task",
- "StartedAt": 1723107950,
- "Status": "Completed",
- "TaskID": "tsk_0458c089402947bbaa27e20c44678be4",
- "CreatedAt": 1723107948,
- "Stats": {
- "DynamicInstructions": 153145,
- "ProcessorTime": 0.008598
}
}
Cancel Task
Cancels the active Task identified by the TaskID
path parameter. To
learn more about Tasks, see the Tasks section in the Signaloid Cloud
Developer Platform Documentation.
Authorizations:
path Parameters
TaskID required | string (TaskID) tsk_[a-z0-9]{32} The identifier of the Task resource. |
Responses
Response samples
- 404
- 500
{- "error": "Not Found"
}
List Task variables
Returns the list of variables that the Signaloid Cloud Compute Engine
discovered in the Task code identified by the TaskID
path parameter.
To learn more about Tasks, see the Tasks section in the Signaloid Cloud
Developer Platform Documentation.
Authorizations:
path Parameters
TaskID required | string (TaskID) tsk_[a-z0-9]{32} The identifier of the Task resource. |
Responses
Response samples
- 200
- 404
{- "TaskID": "tsk_369fd49de2154a28a50fb818c312197e",
- "Variables": [
- {
- "Object": "Variable",
- "Type": "Variable",
- "File": "main.c",
- "Function": "main",
- "Line": 7,
- "Name": "c"
}, - {
- "Object": "Variable",
- "Type": "Variable",
- "File": "main.c",
- "Function": "main",
- "Line": 7,
- "Name": "b"
}, - {
- "Object": "Variable",
- "Type": "Variable",
- "File": "main.c",
- "Function": "main",
- "Line": 7,
- "Name": "a"
}, - {
- "Object": "Variable",
- "Type": "FormalParameter",
- "File": "main.c",
- "Function": "main",
- "Line": 5,
- "Name": "argv"
}, - {
- "Object": "Variable",
- "Type": "FormalParameter",
- "File": "main.c",
- "Function": "main",
- "Line": 5,
- "Name": "argc"
}
], - "Count": 5
}
Get Task outputs
Returns an object with keys corresponding to the Task output streams. By
default, these are stdout
, stderr
, and build
(if present). The
returned values are URLs and enable directly downloading the stream contents.
We also return a chunked and compressed version of stdout
with the key StdoutChunks
.
Authorizations:
path Parameters
TaskID required | string (TaskID) tsk_[a-z0-9]{32} The identifier of the Task resource. |
Responses
Response samples
- 200
- 404
{- "Stdout": "string",
- "Stderr": "string",
- "Build": "string",
- "StdoutChunks": [
- "string"
]
}
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:
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
- 200
- 404
- 500
{- "Samples": [
- -1.0824527064791272,
- -1.1310969119258107,
- -1.0961994836548592,
- -1.0720671348781252,
- -1.1521749654880011,
- -1.1528152657116664,
- -1.1087047905171288,
- -1.1326621923296623,
- -1.0653820188992815,
- -1.0858505883930254,
- -1.1296963560287887,
- -1.1013858150162135,
- -1.0817764623439143,
- -1.1775805891128661,
- -1.070222023706863,
- -1.0750953816720847,
- -1.1568745145008779,
- -1.1036719268767403,
- -1.0878985057236494,
- -1.0993357638716614,
- -1.1407131752971837,
- -1.1437027951679817,
- -1.0901123548429996,
- -1.0891835247279822,
- -1.1566131594680455,
- -1.1163989797228004,
- -1.1022456684084043,
- -1.1367967100453717,
- -1.0960555317070564,
- -1.112673925381313,
- -1.1045915034476725,
- -1.1336645059101502
], - "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:
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
UxValue required | string |
Responses
Request samples
- Payload
{- "UxValue": "string"
}
Response samples
- 200
- 404
- 500
{- "Samples": [
- -1.0824527064791272,
- -1.1310969119258107,
- -1.0961994836548592,
- -1.0720671348781252,
- -1.1521749654880011,
- -1.1528152657116664,
- -1.1087047905171288,
- -1.1326621923296623,
- -1.0653820188992815,
- -1.0858505883930254,
- -1.1296963560287887,
- -1.1013858150162135,
- -1.0817764623439143,
- -1.1775805891128661,
- -1.070222023706863,
- -1.0750953816720847,
- -1.1568745145008779,
- -1.1036719268767403,
- -1.0878985057236494,
- -1.0993357638716614,
- -1.1407131752971837,
- -1.1437027951679817,
- -1.0901123548429996,
- -1.0891835247279822,
- -1.1566131594680455,
- -1.1163989797228004,
- -1.1022456684084043,
- -1.1367967100453717,
- -1.0960555317070564,
- -1.112673925381313,
- -1.1045915034476725,
- -1.1336645059101502
], - "Count": 32
}
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:
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
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:
Request Body schema: application/json
payload required | string |
Responses
Request samples
- Payload
{- "payload": "string"
}