Studio

https://in02-studio-docs.streamspaceai.com/docs
Admin
Studio is a fair-code licensed workflow automation tool that combines AI capabilities with business...
Tokens:135,430
Snippets:2,388
Trust Score:4.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Node into Studio

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/declarative-style-node

Link the local node package into the studio installation directory.

```bash
npm link <node-name>
```

--------------------------------

### Install Studio via npm

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/declarative-style-node

Use this command to install the studio package locally.

```bash
npm install -g @n8n/studio
```

--------------------------------

### Initialize a new project without global installation

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Use the @studio/create-node initializer to scaffold a project directory without installing the CLI globally.

```bash
npm create @studio/node@latest
```

--------------------------------

### Start studio

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/test/run-node-locally

Launch the studio application after linking your nodes.

```bash
studio start
```

--------------------------------

### Install a community node

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/installation/manual-install

Commands to prepare the directory and install a node package from npm.

```bash
mkdir -p ~/.studio/nodes
cd ~/.studio/nodes
npm install <package-name>
```

--------------------------------

### Conversational Agent Prompt Example

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/cluster-nodes/root-nodes/studio-nodes-langchain.agent/conversational-agent

This example demonstrates how to construct a prompt for the Conversational Agent, including tool definitions, format instructions, and user input. Ensure to include `{tools}`, `{format_instructions}`, and `{{input}}` expressions.

```text
TOOLS ------ Assistant can ask the user to use tools to look up information that may be helpful in answering the user's original question. The tools the human can use are:  {tools}  {format_instructions}  USER'S INPUT -------------------- Here is the user's input (remember to respond with a markdown code snippet of a JSON blob with a single action, and NOTHING else):  {{input}} 
```

--------------------------------

### Install studio-node globally

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Install the CLI tool globally using npm to access the studio-node command directly.

```bash
npm install -g @studio/node
```

--------------------------------

### Verify studio-node installation

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Check that the studio-node command is available in your environment.

```bash
studio-node --version
```

--------------------------------

### Initialize Custom Directory

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/declarative-style-node

Create and initialize the custom directory if it does not exist in the studio installation.

```bash
mkdir -p ~/.studio/custom
cd ~/.studio/custom
npm init -y
```

--------------------------------

### Using the Built-in Request Library

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/reference/code-standards

Prefer the built-in request library over third-party npm packages to reduce dependencies and potential vulnerabilities. This example demonstrates making an HTTP GET request.

```typescript
async function process(this: Context, input: any) {
  const response = await this.helpers.request.get('https://example.com/data');
  return response.body;
}
```

--------------------------------

### Dockerfile for Custom Node Installation

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/deploy/install-private-nodes

Use this Dockerfile content to create a Docker image with your custom node installed in ACAI. Ensure the node and credential folders are copied into the container's ~/.studio/custom/ directory.

```dockerfile
FROM <your-base-image>

# Install your custom node
COPY ./dist/node /root/.studio/custom/node
COPY ./dist/credential /root/.studio/custom/credential

# Copy the entrypoint script
COPY docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
RUN chmod +x /usr/local/bin/docker-entrypoint.sh

ENTRYPOINT ["docker-entrypoint.sh"]

```

--------------------------------

### Initialize a new node interactively

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Starts the interactive prompt to define node details, type, and template.

```bash
studio-node new
```

--------------------------------

### Create Lead Notification Subscription API Call Example

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/linkedin

This example demonstrates how to use the leadNotifications API to create a webhook subscription for receiving lead notifications. Subscriptions can be set at owner, form, or associated entity levels.

```javascript
POST https://api.linkedin.com/v2/leadNotifications
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "leadNotificationType": "WEBHOOK",
  "leadNotificationConfiguration": {
    "url": "YOUR_WEBHOOK_URL"
  },
  "subscription": {
    "organization": "urn:li:organization:YOUR_ORG_ID"
  }
}
```

--------------------------------

### Test the node locally

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Starts a local ACAI instance with the node loaded for development testing.

```bash
studio-node dev
```

```bash
npm run dev
```

--------------------------------

### Basic Resource and Operations Setup

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/reference/code-standards

Use this structure when your node performs multiple operations or acts on multiple resources. Define 'Operation' for the action and 'Resource' for the target.

```typescript
{
  "name": "Order",
  "type": "resource",
  "operations": [
    {
      "name": "Get",
      "description": "Retrieves an order.",
      "parameters": [
        {
          "name": "OrderID",
          "value": "order_id",
          "type": "string",
          "displayOptions": {
            "displayName": "Order ID"
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Upgrade to the latest version

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/installation/manual-install

Command to update an installed community node to the latest version.

```bash
npm update <package-name>
```

--------------------------------

### Upgrade or downgrade to a specific version

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/installation/manual-install

Commands to remove the current version and install a specific version of a node.

```bash
npm uninstall <package-name>
npm install <package-name>@<version>
```

--------------------------------

### Load Gmail Labels with loadOptions

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/reference/node-base-files/programmatic-style-parameters

Use the `loadOptions` method to query services for user-specific settings, such as Gmail labels, and render them in the GUI for subsequent queries. This example demonstrates fetching email labels from Gmail.

```javascript
async loadOptions() {
  return {
    email: await this.getEmailLabels()
  }
}
```

--------------------------------

### GET /labels

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/label-operations

Retrieve a list of labels from the Gmail account.

```APIDOC
## GET /labels

### Description
Retrieves multiple labels from the Gmail account.

### Parameters
#### Query Parameters
- **Return All** (boolean) - Optional - Whether to return all labels.
- **Limit** (number) - Optional - Maximum number of labels to return if Return All is disabled.
```

--------------------------------

### Python Built-in Method Example

Source: https://in02-studio-docs.streamspaceai.com/docs/code/code-node

Call built-in methods in Python using the underscore prefix. Type '_' in the editor to see available options.

```python
print(_myCustomMethod())
```

--------------------------------

### GET /events/{eventId} (Get)

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googlecalendar/event-operations

Retrieves the details of a specific event from a Google Calendar.

```APIDOC
## GET /events/{eventId}

### Description
Use this operation to retrieve an event from a Google Calendar.

### Parameters
#### Path Parameters
- **Event ID** (string) - Required - The ID of the event to get.

#### Query Parameters
- **Calendar** (string) - Required - The calendar to get the event from.
- **Max Attendees** (integer) - Optional - Maximum number of attendees to return.
- **Return Next Instance of Recurrent Event** (boolean) - Optional - Whether to return the next instance of a recurring event.
- **Timezone** (string) - Optional - The timezone used in the response.
```

--------------------------------

### JavaScript console.log Example

Source: https://in02-studio-docs.streamspaceai.com/docs/code/code-node

Use console.log for debugging in JavaScript within the Code node. This output is visible in the workflow logs.

```javascript
console.log('Hello from the Code node!');
```

--------------------------------

### JavaScript Promise Example

Source: https://in02-studio-docs.streamspaceai.com/docs/code/code-node

Return a promise in JavaScript to handle asynchronous operations. The workflow will wait for the promise to resolve.

```javascript
return new Promise(resolve => {
  setTimeout(() => {
    resolve(inputData);
  }, 1000);
});
```

--------------------------------

### GET /threads

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/thread-operations

Retrieves a list of multiple Gmail threads based on filters.

```APIDOC
## GET /threads

### Description
Retrieves two or more threads based on specified search criteria and filters.

### Parameters
#### Query Parameters
- **Return All** (boolean) - Optional - Whether to return all threads or a limited set.
- **Limit** (integer) - Optional - Max number of threads to return.
- **Include Spam and Trash** (boolean) - Optional - Include threads from Spam/Trash.
- **Label Names or IDs** (array) - Optional - Filter by specific labels.
- **Search** (string) - Optional - Gmail search query (e.g., 'from:').
- **Read Status** (string) - Optional - Filter by read/unread status.
- **Received After** (string) - Optional - ISO 8601 date/time filter.
- **Received Before** (string) - Optional - ISO 8601 date/time filter.
```

--------------------------------

### Fetch Lead Form Responses API Call Example

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/linkedin

After setting up webhook notifications, use this API call to retrieve the actual lead data submitted through a form. This requires the form ID and organization ID.

```javascript
GET https://api.linkedin.com/v2/leadFormResponses?formId=YOUR_FORM_ID&organizationId=YOUR_ORG_ID
Authorization: Bearer YOUR_ACCESS_TOKEN
```

--------------------------------

### Define SendGrid API Resource

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/programmatic-style-node

Configure the API resource that your node will interact with. This example defines the SendGrid marketing contacts endpoint.

```typescript
{
  "name": "resource",
  "type": "resource",
  "default": {
    "url": "https://api.sendgrid.com/v3/marketing/contacts"
  },
  "options": [
    {
      "name": "resource",
      "value": "https://api.sendgrid.com/v3/marketing/contacts"
    }
  ]
}
```

--------------------------------

### Python Built-in Variable Example

Source: https://in02-studio-docs.streamspaceai.com/docs/code/code-node

Access built-in variables in Python using the underscore prefix. Type '_' in the editor to see available options.

```python
print(_inputData)
```

--------------------------------

### Get Many Shared Drives

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googledrive/shared-drive-operations

Retrieves a list of shared drives. Supports filtering and pagination.

```APIDOC
## GET /drives

### Description
Use this operation to get many shared drives. Supports filtering and pagination.

### Method
GET

### Endpoint
/drives

### Parameters
#### Query Parameters
- **q** (string) - Optional - The query string to use to search for shared drives.
- **useDomainAdminAccess** (boolean) - Optional - Whether to issue the request as a domain administrator.
- **returnAll** (boolean) - Optional - Choose whether to return all results or only up to a given limit. Defaults to false.
- **limit** (integer) - Optional - The maximum number of items to return when **returnAll** is disabled.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **drives** (array) - A list of shared drives.
  - **id** (string) - The ID of the shared drive.
  - **name** (string) - The name of the shared drive.
  - **mimeType** (string) - The mime type of the shared drive.

#### Response Example
{
  "drives": [
    {
      "id": "1a2b3c4d5e6f7g8h9i0j",
      "name": "My Shared Drive 1",
      "mimeType": "application/vnd.google-apps.folder"
    },
    {
      "id": "0k9j8h7g6f5e4d3c2b1a",
      "name": "Another Shared Drive",
      "mimeType": "application/vnd.google-apps.folder"
    }
  ]
}
```

--------------------------------

### Paginate by Number using Query Parameter

Source: https://in02-studio-docs.streamspaceai.com/docs/code/cookbook/http-node/pagination

Set up pagination to increment a query parameter by number for each request. This is useful when APIs expect a 'page' query parameter. The node fetches pages starting from page 1.

```json
{
  "pagination": {
    "mode": "UpdateParameterInEachRequest",
    "type": "Query",
    "name": "page",
    "value": "{{ $pageCount + 1 }}"
  }
}
```

--------------------------------

### Update Rows with Composite Key in MySQL

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.mysql/common-issues

Use the Execute SQL operation for tables with composite keys, as the standard Update operation only supports single-column matching. This example demonstrates matching on both `customer_id` and `product_id`.

```sql
UPDATE your_table
SET column1 = 'new_value'
WHERE customer_id = 123 AND product_id = 456;
```

--------------------------------

### Get a Shared Drive

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googledrive/shared-drive-operations

Retrieves a specific shared drive. You can identify the shared drive by its title, URL, or ID.

```APIDOC
## GET /drives/{driveId}

### Description
Use this operation to get a shared drive.

### Method
GET

### Endpoint
/drives/{driveId}

### Parameters
#### Path Parameters
- **driveId** (string) - Required - The ID of the shared drive to retrieve.

#### Query Parameters
- **useDomainAdminAccess** (boolean) - Optional - Whether to issue the request as a domain administrator.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The ID of the shared drive.
- **name** (string) - The name of the shared drive.
- **mimeType** (string) - The mime type of the shared drive.

#### Response Example
{
  "id": "1a2b3c4d5e6f7g8h9i0j",
  "name": "My Shared Drive",
  "mimeType": "application/vnd.google-apps.folder"
}
```

--------------------------------

### Get Postgres Server Port

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/postgres

Use this SQL query to retrieve the port number the Postgres server is listening on. This is useful for confirming the port during credential setup.

```sql
SELECT inet_server_port(); 
```

--------------------------------

### Get Postgres Server Address

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/postgres

Use this SQL query to retrieve the IP address of the Postgres server. This is helpful for confirming the host name during credential setup.

```sql
SELECT inet_server_addr(); 
```

--------------------------------

### Get File from Telegram

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.telegram/file-operations

Retrieves a file from Telegram using the Bot API getFile method. This node can be used as an AI tool.

```APIDOC
## Get File

### Description
Use this operation to get a file from Telegram using the Bot API getFile method.

### Method
GET

### Endpoint
/getFile

### Parameters
#### Query Parameters
- **credential** (string) - Required - Credential to connect with Telegram.
- **resource** (string) - Required - Must be 'File'.
- **operation** (string) - Required - Must be 'Get'.
- **file_id** (string) - Required - The ID of the file you want to get.
- **download** (boolean) - Optional - Choose whether to download the file (true) or not (false).

### Request Example
{
  "credential": "your_telegram_credential",
  "resource": "File",
  "operation": "Get",
  "file_id": "AgADBAADGqcxG0_j7_xX_40",
  "download": true
}

### Response
#### Success Response (200)
- **file_path** (string) - The path to the file on the Telegram servers.
- **file_size** (integer) - The size of the file in bytes.
- **file_content** (string) - The content of the file if download is enabled.

#### Response Example
{
  "file_path": "photos/file_0.jpg",
  "file_size": 1024,
  "file_content": "...file content..."
}
```

--------------------------------

### Paginate by Number using Body Parameter

Source: https://in02-studio-docs.streamspaceai.com/docs/code/cookbook/http-node/pagination

Configure pagination to increment a body parameter by number for each request, typically used with POST requests. The node fetches pages starting from page 1.

```json
{
  "requestMethod": "POST",
  "pagination": {
    "mode": "UpdateParameterInEachRequest",
    "type": "Body",
    "name": "page",
    "value": "{{ $pageCount + 1 }}"
  }
}
```

--------------------------------

### Clone the node starter repository

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/declarative-style-node

Use these commands to initialize your development environment from the official ACAI template.

```shell
git clone https://github.com/<your-organization>/<your-repo-name>.git studio-nodes-nasa-pics
cd studio-nodes-nasa-pics
```

--------------------------------

### Initialize a node with name and template arguments

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Provides node name and template via command line flags to bypass interactive prompts.

```bash
studio-node new studio-nodes-my-node --template declarative/custom
```

--------------------------------

### Create a new node with options

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Use the initializer with specific options by adding a double dash separator.

```bash
npm create @studio/node@latest -- --template my-template
```

--------------------------------

### Scaffold New Community Nodes

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/build-community-nodes

Initialize a new node project with the required scaffolding and workflow files.

```bash
npm create @studio/node
```

--------------------------------

### Create an Assistant

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-langchain.openai/assistant-operations

Creates a new assistant with specified configurations, including model, name, description, instructions, and tools like code interpreter and knowledge retrieval.

```APIDOC
## Create an Assistant

### Description
Use this operation to create a new assistant.

### Method
POST

### Endpoint
/assistants

### Parameters
#### Request Body
- **credential** (object) - Required - Credential to connect with OpenAI.
- **resource** (string) - Required - Must be 'Assistant'.
- **operation** (string) - Required - Must be 'Create an Assistant'.
- **model** (string) - Required - The model that the assistant will use (e.g., `gpt-4o`, `gpt-4o-mini`).
- **name** (string) - Required - The name of the assistant (max 256 characters).
- **description** (string) - Optional - The description of the assistant (max 512 characters).
- **instructions** (string) - Optional - The system instructions that the assistant uses (max 32,768 characters).
- **codeInterpreter** (boolean) - Optional - Enable the code interpreter for the assistant.
- **knowledgeRetrieval** (boolean) - Optional - Enable knowledge retrieval for the assistant.
  - **files** (array) - Optional - A list of files to upload for external knowledge source.

### Options
- **outputRandomnessTemperature** (number) - Optional - Adjust the randomness of the response (0.0 to 1.0). Defaults to 1.0.
- **outputRandomnessTopP** (number) - Optional - Adjust the Top P setting to control diversity (0.0 to 1.0). Defaults to 1.0.
- **failIfAssistantAlreadyExists** (boolean) - Optional - If enabled, the operation will fail if an assistant with the same name already exists.

### Request Example
```json
{
  "credential": {"id": "your_credential_id"},
  "resource": "Assistant",
  "operation": "Create an Assistant",
  "model": "gpt-4o",
  "name": "My Awesome Assistant",
  "description": "A virtual assistant that helps users with daily tasks.",
  "instructions": "Always respond in a friendly and engaging manner.",
  "codeInterpreter": true,
  "knowledgeRetrieval": true,
  "files": [{"id": "file_abc123"}]
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created assistant.
- **name** (string) - The name of the assistant.
- **description** (string) - The description of the assistant.
- **model** (string) - The model used by the assistant.
- **instructions** (string) - The system instructions for the assistant.
- **tools** (array) - The tools enabled for the assistant (e.g., code_interpreter, retrieval).
- **created_at** (string) - Timestamp of assistant creation.

#### Response Example
```json
{
  "id": "asst_abc123xyz",
  "name": "My Awesome Assistant",
  "description": "A virtual assistant that helps users with daily tasks.",
  "model": "gpt-4o",
  "instructions": "Always respond in a friendly and engaging manner.",
  "tools": [
    {"type": "code_interpreter"},
    {"type": "retrieval"}
  ],
  "created_at": "2024-01-01T12:00:00Z"
}
```
```

--------------------------------

### Get Template Collection

Source: https://in02-studio-docs.streamspaceai.com/docs/workflows/templates

Retrieves a specific collection of workflow templates.

```APIDOC
## GET /templates/collections/{id}

### Description
Retrieves a specific template collection.

### Method
GET

### Endpoint
`/templates/collections/<id>`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the template collection.
```

--------------------------------

### GET /conversations/{conversationId}

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-langchain.openai/conversation-operations

Retrieve the details of an existing conversation by its ID.

```APIDOC
## GET /conversations/{conversationId}

### Description
Retrieves an existing conversation.

### Parameters
#### Path Parameters
- **Conversation ID** (string) - Required - The ID of the conversation to retrieve.
```

--------------------------------

### Run the release command

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Execute the 'release' command in your project directory to build, lint, update the changelog, tag, and publish your node. This command automates the release process.

```bash
release
```

--------------------------------

### GET /threads/{threadId}

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/thread-operations

Retrieves a single Gmail thread by its ID.

```APIDOC
## GET /threads/{threadId}

### Description
Retrieves a single thread. Supports simplified response format or raw data.

### Parameters
#### Path Parameters
- **Thread ID** (string) - Required - The ID of the thread to retrieve.
#### Query Parameters
- **Simplify** (boolean) - Optional - Returns metadata if true (default).
- **Return Only Messages** (boolean) - Optional - If true, returns only thread messages.
```

--------------------------------

### GET /labels/{labelId}

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/label-operations

Retrieve details of a specific label by its ID.

```APIDOC
## GET /labels/{labelId}

### Description
Retrieves information about a specific label.

### Parameters
#### Path Parameters
- **Label ID** (string) - Required - The ID of the label to retrieve.
```

--------------------------------

### Set up sample data with Code node

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/core-nodes/studio-nodes-base.removeduplicates/templates-and-examples

Use this JavaScript snippet in a Code node set to 'Run Once for Each Item' to generate input data for the Remove Duplicates node.

```javascript
return {
  data: [
    { id: 1, name: "Taylor Swift", job: "Pop star", last_updated: "2024-09-20T10:12:43.493Z" },
    { id: 2, name: "Ed Sheeran", job: "Singer-songwriter", last_updated: "2024-10-05T08:30:59.493Z" },
    { id: 3, name: "Adele", job: "Singer-songwriter", last_updated: "2024-10-07T14:15:59.493Z" },
    { id: 4, name: "Bruno Mars", job: "Singer-songwriter", last_updated: "2024-08-25T17:45:12.493Z" },
    { id: 5, name: "Billie Eilish", job: "Singer-songwriter", last_updated: "2024-09-10T09:30:12.493Z" },
    { id: 6, name: "Katy Perry", job: "Pop star", last_updated: "2024-10-08T12:30:45.493Z" },
    { id: 7, name: "Lady Gaga", job: "Pop star", last_updated: "2024-09-15T14:45:30.493Z" },
    { id: 8, name: "Rihanna", job: "Pop star", last_updated: "2024-10-01T11:50:22.493Z" },
    { id: 9, name: "Taylor Swift", job: "Pop star", last_updated: "2024-09-20T10:12:43.493Z" },
    { id: 10, name: "Ed Sheeran", job: "Singer-songwriter", last_updated: "2024-10-05T08:30:59.493Z" }
  ]
};
```

--------------------------------

### GET /get-rows

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googlesheets/sheet-operations

Reads one or more rows from a sheet, with optional filtering and formatting.

```APIDOC
## GET /get-rows

### Description
Use this operation to read one or more rows from a sheet.

### Parameters
#### Request Body
- **Credential** (string) - Required - Google Sheets credentials.
- **Resource** (string) - Required - Must be 'Sheet Within Document'.
- **Operation** (string) - Required - Must be 'Get Row(s)'.
- **Document** (string) - Required - Spreadsheet identifier.
- **Sheet** (string) - Required - Sheet identifier.
- **Filters** (object) - Optional - Column and Value to search against.

### Options
- **Data Location on Sheet** (string) - Optional - Specify a data range.
- **Output Formatting** (string) - Optional - Choose between Values (unformatted), Values (formatted), or Formulas.
- **Date Formatting** (string) - Optional - Choose between Formatted Text or Serial Number.
- **When Filter Has Multiple Matches** (string) - Optional - Set to 'Return All Matches' to override default single-result behavior.
```

--------------------------------

### Log in to npm

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Before releasing your node, you must log in to npm to authorize publishing. This ensures that 'studio-node' has the necessary permissions.

```bash
npm login
```

--------------------------------

### List MySQL Databases

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/mysql

Use this query to list all databases available on the server.

```sql
SHOW DATABASES; 
```

--------------------------------

### Build the node project

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Compiles TypeScript files and bundles assets using the CLI or npm.

```bash
studio-node build
```

```bash
npm run build
```

--------------------------------

### Publish Node Locally

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/declarative-style-node

Run this command in your node project directory to make it available for local linking.

```bash
npm link
```

--------------------------------

### Get Many Messages

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/message-operations

Retrieves multiple Gmail messages based on specified criteria.

```APIDOC
## GET /messages

### Description
Retrieves a list of Gmail messages based on various filters and criteria.

### Method
GET

### Endpoint
/messages

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user's mailbox. Typically 'me'.
- **maxResults** (integer) - Optional - The maximum number of messages to return. Defaults to 100.
- **pageToken** (string) - Optional - The page token to retrieve the next page of results.
- **q** (string) - Optional - Gmail search refine filters (e.g., 'from:example.com', 'is:unread').
- **labelIds** (string) - Optional - Comma-separated list of label IDs to filter messages by.
- **includeSpamTrash** (boolean) - Optional - Whether to include messages from Spam and Trash folders. Defaults to false.
- **format** (string) - Optional - The format of the response. Can be 'metadata' (simplified) or 'full' (raw). Defaults to 'metadata'.
- **after** (string) - Optional - Return only emails received after the specified date/time (ISO 8601 format or timestamp in milliseconds).
- **before** (string) - Optional - Return only emails received before the specified date/time (ISO 8601 format or timestamp in milliseconds).
- **sender** (string) - Optional - Filter messages by sender email address or part of the sender's name.
- **unread** (boolean) - Optional - Filter by read status. If true, returns unread emails only. If false, returns read emails only. If omitted, returns both.

### Response
#### Success Response (200)
- **messages** (array of objects) - A list of message resources.
  - **id** (string) - The unique ID of the message.
  - **threadId** (string) - The unique ID of the thread associated with the message.
  - **labelIds** (array of strings) - The list of label IDs applied to the message.
- **nextPageToken** (string) - Token for the next page of results, if available.
- **resultSizeEstimate** (integer) - An estimate of the total number of messages that match the query.

#### Response Example
```json
{
  "messages": [
    {
      "id": "17a8b9c0d1e2f3a4",
      "threadId": "0a1b2c3d4e5f6a7b",
      "labelIds": ["INBOX", "UNREAD"]
    },
    {
      "id": "17a8b9c0d1e2f3a5",
      "threadId": "0a1b2c3d4e5f6a7c",
      "labelIds": ["INBOX"]
    }
  ],
  "nextPageToken": "nextPageTokenValue",
  "resultSizeEstimate": 500
}
```
```

--------------------------------

### POST /openai/video/generate

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-langchain.openai/video-operations

Generates a video from a text prompt using specified OpenAI models.

```APIDOC
## POST /openai/video/generate

### Description
Use this operation to generate a video from a text prompt.

### Method
POST

### Parameters
#### Request Body
- **Credential** (string) - Required - Create or select an existing OpenAI credential.
- **Resource** (string) - Required - Must be set to 'Video'.
- **Operation** (string) - Required - Must be set to 'Generate Video'.
- **Model** (string) - Required - The model to use (sora-2, sora-2-pro).
- **Prompt** (string) - Required - The prompt to generate a video from.
- **Seconds** (integer) - Required - Clip duration in seconds (up to 25).
- **Size** (string) - Required - Output resolution formatted as width x height.
- **Reference** (binary) - Optional - Image reference that guides generation.
- **Wait Timeout** (integer) - Optional - Time to wait for generation in seconds (default: 300).
- **Output Field Name** (string) - Optional - Name of the output field for binary data (default: data).

### Request Example
{
  "model": "sora-2",
  "prompt": "A cinematic shot of a futuristic city",
  "seconds": 10,
  "size": "1024x1024"
}

### Response
#### Success Response (200)
- **data** (binary) - The generated video file data.
```

--------------------------------

### Get a Message

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.gmail/message-operations

Retrieves a single Gmail message, either in a simplified format or as raw data.

```APIDOC
## GET /messages/{messageId}

### Description
Retrieves a single Gmail message. You can choose to get a simplified version (metadata) or the raw data.

### Method
GET

### Endpoint
/messages/{messageId}

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the message to retrieve.

#### Query Parameters
- **format** (string) - Optional - The format of the response. Can be 'metadata' (simplified) or 'full' (raw). Defaults to 'metadata'.

### Response
#### Success Response (200)
- **id** (string) - The unique ID of the message.
- **threadId** (string) - The unique ID of the thread associated with the message.
- **labelIds** (array of strings) - The list of label IDs applied to the message.
- **snippet** (string) - A snippet of the message's text.
- **payload** (object) - The message's content (if format is 'full').

#### Response Example
```json
{
  "id": "17a8b9c0d1e2f3a4",
  "threadId": "0a1b2c3d4e5f6a7b",
  "labelIds": ["INBOX", "UNREAD"],
  "snippet": "This is a sample message snippet.",
  "payload": {
    "partId": "0",
    "mimeType": "text/plain",
    "filename": "",
    "headers": {
      "Date": "Tue, 15 Aug 2023 10:00:00 +0000",
      "From": "Sender Name <sender@example.com>",
      "To": "Recipient Name <recipient@example.com>",
      "Subject": "Sample Subject"
    },
    "body": {
      "size": 123,
      "data": "SGVsbG8sIHRoaXMgaXMgYSBzYW1wbGUgYm9keS4="
    }
  }
}
```
```

--------------------------------

### Get Many Events

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googlecalendar/event-operations

Retrieves multiple events from a Google Calendar based on specified criteria.

```APIDOC
## GET /calendar/events

### Description
Use this operation to retrieve more than one event from a Google Calendar.

### Method
GET

### Endpoint
/calendar/events

### Parameters
#### Query Parameters
- **credential** (string) - Required - Credential to connect with Google Calendar.
- **resource** (string) - Required - Must be 'Event'.
- **operation** (string) - Required - Must be 'Get Many'.
- **calendar** (string) - Required - The calendar to get events from. Can be a title or ID.
- **returnAll** (boolean) - Optional - Whether to return all results or only up to a given limit.
- **limit** (integer) - Optional - The maximum number of results to return (used when 'returnAll' is false).
- **after** (string) - Optional - Retrieve events that occur after this time. Defaults to the current time.
- **before** (string) - Optional - Retrieve events that occur before this time. Defaults to current time plus one week.
- **fields** (string) - Optional - Specify the fields to return. Defaults to commonly used fields. Use '*' for all fields.
- **iCalUID** (string) - Optional - Specifies an event ID (in the iCalendar format) to include in the response.
- **maxAttendees** (integer) - Optional - The maximum number of attendees to include in the response.
- **orderBy** (string) - Optional - The order to use for the events in the response.
- **query** (string) - Optional - Free text search terms to find events that match.
- **recurringEventHandling** (string) - Optional - What to do for recurring events: 'All Occurrences', 'First Occurrence', 'Next Occurrence'.
- **showDeleted** (boolean) - Optional - Whether to include deleted events in the results.
- **showHiddenInvitations** (boolean) - Optional - Whether to include hidden invitations in the results.
- **timezone** (string) - Optional - The timezone used in the response.
- **updatedMin** (string) - Optional - The lower bounds for an event's last modification time (RFC 3339 timestamp).

### Response
#### Success Response (200)
- **events** (array) - An array of event objects.

#### Response Example
```json
{
  "events": [
    {
      "summary": "Team Meeting",
      "start": {
        "dateTime": "2023-10-27T10:00:00-07:00",
        "timeZone": "America/Los_Angeles"
      },
      "end": {
        "dateTime": "2023-10-27T11:00:00-07:00",
        "timeZone": "America/Los_Angeles"
      }
    }
  ]
}
```
```

--------------------------------

### Configure Drag and Drop for Data Keys

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/reference/ui-elements

Add configuration options to enable drag and drop functionality for data keys. Use 'single' for single string requirements and 'multiple' for comma-separated lists.

```json
{
  "requiresDataPath": "single"
}
```

```json
{
  "requiresDataPath": "multiple"
}
```

--------------------------------

### Clone ACAI Node Starter Repository

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/programmatic-style-node

Clone the ACAI node starter repository to begin building your custom node. Navigate into the cloned directory to proceed with development.

```shell
git clone https://github.com/<your-organization>/<your-repo-name>.git studio-nodes-friendgrid
cd studio-nodes-friendgrid
```

--------------------------------

### Get Chat Member

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.telegram/chat-operations

Retrieves the details of a specific chat member using the Bot API getChatMember method.

```APIDOC
## GET /getChatMember

### Description
Use this operation to get the details of a chat member using the Bot API getChatMember method.

### Method
GET

### Endpoint
/getChatMember

### Parameters
#### Query Parameters
- **credential** (string) - Required - Credential to connect with Telegram.
- **resource** (string) - Required - Must be 'Chat'.
- **operation** (string) - Required - Must be 'Get Member'.
- **chat_id** (string) - Required - The Chat ID or username of the target channel in the format `@channelusername`.
- **user_id** (string) - Required - The unique identifier of the user whose information you want to get.

### Response
#### Success Response (200)
- **member_info** (object) - Details of the chat member.

#### Response Example
```json
{
  "member_info": {
    "user": {
      "id": 987654321,
      "first_name": "User"
    },
    "status": "member"
  }
}
```
```

--------------------------------

### Get Chat Administrators

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.telegram/chat-operations

Retrieves a list of all administrators in a Telegram chat using the Bot API getChatAdministrators method.

```APIDOC
## GET /getChatAdministrators

### Description
Use this operation to get a list of all administrators in a chat using the Bot API getChatAdministrators method.

### Method
GET

### Endpoint
/getChatAdministrators

### Parameters
#### Query Parameters
- **credential** (string) - Required - Credential to connect with Telegram.
- **resource** (string) - Required - Must be 'Chat'.
- **operation** (string) - Required - Must be 'Get Administrators'.
- **chat_id** (string) - Required - The Chat ID or username of the target channel in the format `@channelusername`.

### Response
#### Success Response (200)
- **administrators** (array) - A list of administrator objects.

#### Response Example
```json
{
  "administrators": [
    {
      "user": {
        "id": 123456789,
        "is_bot": false,
        "first_name": "Admin"
      },
      "status": "administrator"
    }
  ]
}
```
```

--------------------------------

### POST /folders/create

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googledrive/folder-operations

Creates a new folder within a specified parent drive or folder.

```APIDOC
## POST /folders/create

### Description
Creates a new folder in a Google Drive.

### Method
POST

### Parameters
#### Request Body
- **Folder Name** (string) - Required - The name to use for the new folder.
- **Parent Drive** (string) - Required - The drive identifier (From list, URL, or ID).
- **Parent Folder** (string) - Required - The parent folder identifier (From list, URL, or ID).
- **Folder Color** (string) - Optional - The color of the folder as an RGB hex string.
- **Simplify Output** (boolean) - Optional - Whether to return a simplified response.
```

--------------------------------

### Get Chat Information

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.telegram/chat-operations

Retrieves up-to-date information about a Telegram chat using the Bot API getChat method.

```APIDOC
## GET /getChat

### Description
Use this operation to get up to date information about a chat using the Bot API getChat method.

### Method
GET

### Endpoint
/getChat

### Parameters
#### Query Parameters
- **credential** (string) - Required - Credential to connect with Telegram.
- **resource** (string) - Required - Must be 'Chat'.
- **operation** (string) - Required - Must be 'Get'.
- **chat_id** (string) - Required - The Chat ID or username of the target channel in the format `@channelusername`.

### Response
#### Success Response (200)
- **chat_info** (object) - Detailed information about the chat.

#### Response Example
```json
{
  "chat_info": {
    "id": 123456789,
    "type": "private",
    "title": "Example Chat"
  }
}
```
```

--------------------------------

### Implement rate limit workaround with Loop Over Items

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-langchain.openai/common-issues

Use this workflow template to split data into smaller chunks and introduce a delay to avoid exceeding OpenAI rate limits.

```json
{     "nodes": [     {         "parameters": {},         "id": "35d05920-ad75-402a-be3c-3277bff7cc67",         "name": "When clicking ‘Execute workflow’",         "type": "studio-nodes-base.manualTrigger",         "typeVersion": 1,         "position": [         880,         400         ]     },     {         "parameters": {         "batchSize": 500,         "options": {}         },         "id": "ae9baa80-4cf9-4848-8953-22e1b7187bf6",         "name": "Loop Over Items",         "type": "studio-nodes-base.splitInBatches",         "typeVersion": 3,         "position": [         1120,         420         ]     },     {         "parameters": {         "resource": "chat",         "options": {},         "requestOptions": {}         },         "id": "a519f271-82dc-4f60-8cfd-533dec580acc",         "name": "OpenAI",         "type": "studio-nodes-base.openAi",         "typeVersion": 1,         "position": [         1380,         440         ]     },     {         "parameters": {         "unit": "minutes"         },         "id": "562d9da3-2142-49bc-9b8f-71b0af42b449",         "name": "Wait",         "type": "studio-nodes-base.wait",         "typeVersion": 1,         "position": [         1620,         440         ],         "webhookId": "714ab157-96d1-448f-b7f5-677882b92b13"     }     ],     "connections": {     "When clicking ‘Execute workflow’": {         "main": [         [             {             "node": "Loop Over Items",             "type": "main",             "index": 0             }         ]         ]     },     "Loop Over Items": {         "main": [         null,         [             {             "node": "OpenAI",             "type": "main",             "index": 0             }         ]         ]     },     "OpenAI": {         "main": [         [             {             "node": "Wait",             "type": "main",             "index": 0             }         ]         ]     },     "Wait": {         "main": [         [             {             "node": "Loop Over Items",             "type": "main",             "index": 0             }         ]         ]     }     },     "pinData": {} }
```

--------------------------------

### Create a Spreadsheet

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.googlesheets/document-operations

Creates a new Google Spreadsheet with specified sheets and options.

```APIDOC
## POST /spreadsheets.create

### Description
Use this operation to create a new spreadsheet.

### Method
POST

### Endpoint
/spreadsheets.create

### Parameters
#### Request Body
- **credential** (object) - Required - Credential to connect with Google Sheets.
- **resource** (string) - Required - Must be 'Document'.
- **operation** (string) - Required - Must be 'Create'.
- **title** (string) - Required - The title of the new spreadsheet.
- **sheets** (array) - Required - An array of strings, where each string is the title of a sheet to create within the spreadsheet.

#### Query Parameters
- **locale** (string) - Optional - The locale of the spreadsheet (e.g., 'en', 'en_US'). Affects formatting.
- **recalculationInterval** (string) - Optional - The recalculation interval for spreadsheet functions (e.g., 'On Change', 'Minute', 'Hour').

### Request Example
{
  "credential": {
    "apiKey": "YOUR_API_KEY"
  },
  "resource": "Document",
  "operation": "Create",
  "title": "My New Spreadsheet",
  "sheets": ["Sheet1", "Sheet2"]
}

### Response
#### Success Response (200)
- **spreadsheetId** (string) - The ID of the newly created spreadsheet.
- **spreadsheetUrl** (string) - The URL of the newly created spreadsheet.

#### Response Example
{
  "spreadsheetId": "12345abcdeFGHijklmnOPQ",
  "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/12345abcdeFGHijklmnOPQ/edit#gid=0"
}
```

--------------------------------

### Configure Custom Auth with Headers and Query String

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/httprequest

Use this JSON structure to combine header-based and query-string-based authentication.

```json
{ 	"headers": { 		"api-version": "202404" 	}, 	"qs": { 		"apikey": "my-api-key" 	} }
```

--------------------------------

### Configure Custom Auth with Query String

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/httprequest

Use this JSON structure to pass authentication credentials as query parameters.

```json
{ 	"qs": {  		"appid": "123456", 		"apikey": "my-api-key" 	} }
```

--------------------------------

### Expose Local Server with ngrok

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/getresponse

Use ngrok to expose your local server running on port 5678 to the internet. This is necessary for GetResponse OAuth2 callbacks during local development.

```bash
ngrok http 5678
```

--------------------------------

### Construct an IN group query with parameters

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.postgres/common-issues

Use an empty set of parentheses in the SQL query to prepare for dynamic placeholder injection.

```sql
SELECT * FROM shirts WHERE size IN ()
```

--------------------------------

### Lint the node project

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/studio-node

Runs the linting script to check code quality, with options for automatic fixes.

```bash
studio-node lint
```

```bash
npm run lint
```

```bash
npm run lint:fix
```

--------------------------------

### Cloning Incoming Data

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/creating-nodes/build/reference/code-standards

When modifying data, clone the incoming data to avoid affecting sibling nodes. This example shows a basic cloning approach.

```typescript
async function process(this: Context, input: any) {
  const clonedInput = JSON.parse(JSON.stringify(input));
  // Modify clonedInput
  return clonedInput;
}
```

--------------------------------

### Map host.docker.internal to host-gateway on Linux

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/app-nodes/studio-nodes-base.mysql/common-issues

If running ACAI in Docker on Linux, use the `--add-host` flag to map `host.docker.internal` to `host-gateway`. This is necessary for ACAI to connect to services running on the host machine, such as a MySQL server.

```bash
docker run --add-host=host.docker.internal:host-gateway ...
```

--------------------------------

### Lint and Test Community Nodes

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/build-community-nodes

Commands to verify node structure and functionality locally during development.

```bash
npm run lint
```

```bash
npm run dev
```

--------------------------------

### Configure local environment redirect URL

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/builtin/credentials/twist

Set the environment variable for the OAuth redirect URL using the ngrok tunnel address.

```bash
export N8N_HOST=<YOUR-NGROK-URL>
export N8N_PROTOCOL=https
npm run start
```

--------------------------------

### Release New Node Version

Source: https://in02-studio-docs.streamspaceai.com/docs/integrations/community-nodes/build-community-nodes

Command to increment version, commit, tag, and push changes to trigger the publishing workflow.

```bash
npm run release
```
Tokens:
Raw