n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/airtop/v1/resource_extraction/operation_scrape.ts

Base nodes of n8n

/**
 * Airtop Node - Version 1
 * Discriminator: resource=extraction, operation=scrape
 */


interface Credentials {
  airtopApi: CredentialReference;
}

/** Scrape a page and return the data as markdown */
export type AirtopV1ExtractionScrapeParams = {
  resource: 'extraction';
  operation: 'scrape';
/**
 * Choose between creating a new session or using an existing one
 * @default existing
 */
    sessionMode?: 'new' | 'existing' | Expression<string>;
/**
 * The ID of the &lt;a href="https://docs.airtop.ai/guides/how-to/creating-a-session" target="_blank"&gt;Session&lt;/a&gt; to use
 * @displayOptions.show { sessionMode: ["existing"] }
 * @default ={{ $json["sessionId"] }}
 */
    sessionId?: string | Expression<string> | PlaceholderValue;
/**
 * The ID of the &lt;a href="https://docs.airtop.ai/guides/how-to/creating-a-session#windows" target="_blank"&gt;Window&lt;/a&gt; to use
 * @displayOptions.show { sessionMode: ["existing"] }
 * @default ={{ $json["windowId"] }}
 */
    windowId?: string | Expression<string> | PlaceholderValue;
/**
 * URL to load in the window
 * @displayOptions.show { sessionMode: ["new"] }
 */
    url?: string | Expression<string> | PlaceholderValue;
/**
 * The name of the Airtop profile to load or create
 * @hint &lt;a href="https://docs.airtop.ai/guides/how-to/saving-a-profile" target="_blank"&gt;Learn more&lt;/a&gt; about Airtop profiles
 * @displayOptions.show { sessionMode: ["new"] }
 */
    profileName?: string | Expression<string> | PlaceholderValue;
/**
 * Whether to terminate the session after the operation is complete. When disabled, you must manually terminate the session. By default, idle sessions timeout after 10 minutes
 * @displayOptions.show { sessionMode: ["new"] }
 * @default true
 */
    autoTerminateSession?: boolean | Expression<boolean>;
};

export type AirtopV1ExtractionScrapeOutput = {
  data?: {
    modelResponse?: {
      scrapedContent?: {
        contentType?: string;
        text?: string;
      };
      title?: string;
    };
  };
  meta?: {
    requestId?: string;
    status?: string;
    usage?: {
      credits?: number;
      id?: string;
    };
  };
  sessionId?: string;
  windowId?: string;
};

export type AirtopV1ExtractionScrapeNode = {
  type: 'n8n-nodes-base.airtop';
  version: 1;
  credentials?: Credentials;
  config: NodeConfig<AirtopV1ExtractionScrapeParams>;
  output?: Items<AirtopV1ExtractionScrapeOutput>;
};