Interface: BlackboxPayload

Defined in: src/_other-scraper/blackbox.ts:15

The BlackboxPayload interface represents the structure of the payload sent to the Blackbox AI API. This interface defines several properties that configure the API request behavior.

Properties

messages

messages: ChatMessage[]

An array of ChatMessage objects, which represent the series of messages to be processed by the Blackbox AI API.

id

id: string

A unique identifier for the payload. This value is typically assigned to track specific requests and responses.

codeModelMode

codeModelMode: boolean

Indicates whether the code model mode should be enabled. When set to true, the API may utilize a specialized model for processing code-related queries.

trendingAgentMode

trendingAgentMode: object

An object that holds configurations related to trending agents. The specific structure and properties of this object should be defined according to the API’s requirements.

isMicMode

isMicMode: boolean

Enables microphone mode if set to true. This mode allows the API to handle voice input directly.

maxTokens

maxTokens: number

Specifies the maximum number of tokens the API should generate in response. This can help control the length of the output.

isChromeExt

isChromeExt: boolean

Indicates whether the request is coming from a Chrome extension. This property can modify the API’s behavior based on the context.

githubToken

githubToken: string

A personal access token for GitHub, required if the API is expected to interact with GitHub resources. This should be kept secure.

clickedForceWebSearch

clickedForceWebSearch: boolean

Determines whether the user explicitly requested a forced web search. It can be used to prioritize web search results in the API response.

visitFromDelta

visitFromDelta: boolean

Indicates if the visit originated from a Delta request. This may affect how the data is processed and returned.

isMemoryEnabled

isMemoryEnabled: boolean

Specifies whether memory capabilities are enabled for persistent context across interactions.

mobileClient

mobileClient: boolean

Indicates if the request is originating from a mobile client. This can tailor the API response for mobile usage.

validated

validated: string

A validation status string that provides information about the authenticity of the request.

imageGenerationMode

imageGenerationMode: boolean

When enabled, specifies that the request is for image generation.

webSearchModePrompt

webSearchModePrompt: boolean

Indicates that the API should respond with prompts suitable for web search mode.

deepSearchMode

deepSearchMode: boolean

Enables deep search mode when set to true. This mode allows for more extensive and comprehensive search capabilities.

vscodeClient

vscodeClient: boolean

Indicates that the request is coming from a Visual Studio Code client, which may affect how responses are formatted.

codeInterpreterMode

codeInterpreterMode: boolean

Enables a code interpreter mode if set to true, allowing the API to analyze and interpret code snippets directly.

customProfile

customProfile: object

An object containing custom profile information.

name

name: string

The name of the user or entity being represented in the profile.

occupation

occupation: string

The occupation of the user, which may influence the API’s responses.

traits

traits: string[]

An array of traits that describe the user, helping the API tailor its responses based on individual characteristics.

additionalInfo

additionalInfo: string

Any additional information relevant to customizing the API’s behavior.

enableNewChats

enableNewChats: boolean

When set to true, new chat sessions can be initiated based on the payload’s context.

webSearchModeOption

webSearchModeOption: object

An object that defines options for web search mode.

autoMode

autoMode: boolean

Enables automatic mode if set to true, allowing the API to manage search parameters dynamically.

webMode

webMode: boolean

Specifies whether the API should operate in web mode, influencing how the API structures responses.

offlineMode

offlineMode: boolean

Indicates if the API should function in offline mode, adjusting its response capabilities accordingly.

isPremium

isPremium: boolean

Denotes whether the user’s account has premium features enabled, which may unlock advanced API functionalities.

beastMode

beastMode: boolean

When enabled, activates a high-performance mode, allowing for potentially more powerful API responses.

designerMode

designerMode: boolean

Enables a designer-focused mode if set to true, providing outputs more tailored to design-related queries.

asyncMode

asyncMode: boolean

Indicates if asynchronous processing should be employed, which can improve performance in handling the request.