IntelligenceX
Cmdlet

Start-IntelligenceXApiKeyLogin

Namespace IntelligenceX.PowerShell
Inputs
IntelligenceX.OpenAI.IntelligenceXClient

Authenticates the active client with an OpenAI API key.

Examples

Example 1


Start-IntelligenceXApiKeyLogin -ApiKey $env:OPENAI_API_KEY

Log in with an API key

Example 2


$client = Connect-IntelligenceX; Start-IntelligenceXApiKeyLogin -Client $client -ApiKey $env:OPENAI_API_KEY; Get-IntelligenceXAccount -Client $client

Log in with an explicit client and verify account access

Example 3


Start-IntelligenceXApiKeyLogin -ApiKey (Get-Item Env:OPENAI_API_KEY).Value

Use API key auth in non-interactive CI flows

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Start-IntelligenceXApiKeyLogin -ApiKey <string> [-Client <IntelligenceXClient>] [<CommonParameters>]
#

Parameters

ApiKey string requiredposition: namedpipeline: false
OpenAI API key used for authentication.
Client IntelligenceXClient optionalposition: namedpipeline: true (ByValue)
Client instance to use. Defaults to the active client.