CLI

API Key Commands

Commands for managing API keys

The apikey commands allow you to create, list, delete, and manage API keys for authentication with the Agentuity Cloud Platform.

Commands

apikey

Base command for API key management.

$
agentuity apikey

Aliases: apikeys

Examples:

$
agentuity apikey list
$
agentuity apikey create

apikey create

Creates a new API key for use with the Agentuity Cloud Platform.

$
agentuity apikey create

Aliases: new, add

Flags:

  • --expires-at string - The expiration date of the API key
  • --format string - The format to output the API key in (default "text")
  • -h, --help - help for create
  • -o, --org-id string - The organization ID to associate the API key with
  • -p, --project-id string - The project ID to associate the API key with

apikey delete

Deletes an existing API key.

$
agentuity apikey delete [id]

Aliases: rm, del

Specify an optional API key ID to delete a specific API key or choose from a list of API keys.

apikey get

Retrieves information about a specific API key.

$
agentuity apikey get [id]

Aliases: None

Specify an optional API key ID to get a specific API key or choose from a list of API keys.

Flags:

  • --format string - The format to output the API key in (default "text")
  • -h, --help - help for get
  • -m, --mask - Mask the API key value

apikey list

Lists all available API keys for your account.

$
agentuity apikey list

Aliases: None

Flags:

  • --format string - The format to output the API key in (default "text")
  • -h, --help - help for list
  • -m, --mask - Mask the API key value
  • -o, --org-id string - The organization ID to filter by
  • -p, --project-id string - The project ID to filter by

Need Help?

Join our DiscordCommunity for assistance or just to hang with other humans building agents.

Send us an email at hi@agentuity.com if you'd like to get in touch.

Please Follow us on

If you haven't already, please Signup for your free account now and start building your first agent!

On this page