SoulFire LogoSoulFire

Get script

Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges.

GET
/v1/instances/{instance_id}/scripts/{script_id}

Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The instance containing the script. Format: UUID string.

Formatuuid
script_id*string

The ID of the script to retrieve. Format: UUID string.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/scripts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "script": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "nodes": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "position": {          "x": 0.1,          "y": 0.1        },        "data": {          "property1": null,          "property2": null        },        "muted": true,        "collapsed": true,        "width": 0.1,        "height": 0.1,        "containedNodes": [          "string"        ],        "label": "string",        "resolvedType": "PORT_TYPE_ANY",        "parentFrameId": "string"      }    ],    "edges": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "source": "string",        "sourceHandle": "string",        "target": "string",        "targetHandle": "string",        "edgeType": "EDGE_TYPE_EXECUTION",        "order": 0      }    ],    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",    "paused": true,    "quotas": {      "maxExecutionCount": "string",      "maxExecutionTimeMs": "string",      "maxConcurrentTriggers": 0,      "maxStateStoreEntries": "string",      "disableTimeouts": true    }  }}

How is this page?

Deactivate script POST

Deactivates an active script. Unregisters all event listeners and cancels any pending async operations.

Update script PATCH

Updates an existing script's metadata and/or node graph. Only specified fields are updated; others remain unchanged. Use update_nodes/update_edges flags to explicitly set empty lists.