h2oGPTe icon

h2oGPTe

h2oGPTe is an AI-powered search assistant for your internal teams to answer questions gleaned from large volumes of documents, websites and workplace content.

Actions198

Overview

The "Agent" resource with the "Updates Agent Key" operation allows users to update an existing agent key by specifying its ID and optionally modifying its attributes such as name, type, value, and description. This node is useful in scenarios where API keys or tokens associated with agents need to be updated without creating new keys, for example, when rotating credentials or updating metadata related to the key.

Practical examples:

  • Updating the value of an API key used by an agent to maintain secure access.
  • Changing the descriptive name or type of a key to better reflect its purpose.
  • Modifying the description to add context or notes about the key usage.

Properties

Name Meaning
Key ID The unique identifier of the agent key to be updated (required).
Additional Options Optional fields to update on the agent key:
- Name New name for the agent key.
- Type New type designation for the agent key.
- Value New value of the agent key (e.g., the actual token or secret).
- Description New description providing additional information about the agent key.

Output

The node outputs the full response from the API call that updates the agent key. The output JSON typically contains details of the updated key, including its ID and any updated properties. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authentication to the external service's API.
  • The base URL for API requests is configured via credentials and must be set correctly.
  • The node sends a POST request to the endpoint /agents/keys/{key_id} with the updated data in the request body.

Troubleshooting

  • Missing or invalid Key ID: Ensure the "Key ID" property is provided and corresponds to an existing agent key.
  • Authentication errors: Verify that the API key credential is valid and has permissions to update agent keys.
  • Invalid field values: When updating fields like "type" or "value", ensure they conform to expected formats or allowed values by the API.
  • Network or timeout issues: Check network connectivity and API server availability; increase timeout settings if necessary.
  • API errors: Review error messages returned by the API for specific causes such as permission denied or invalid input.

Links and References

  • Refer to the external API documentation for agent key management for detailed information on allowed fields and validation rules.
  • Consult n8n documentation on how to configure API key credentials and handle HTTP request nodes for custom integrations.

Discussion