agent_api_keys

Creates, updates, deletes, gets or lists an agent_api_keys resource.

Overview

Name	agent_api_keys
Type	Resource
Id	digitalocean.genai.agent_api_keys

Fields

The following fields are returned by SELECT queries:

genai_list_agent_api_keys

A successful response.

Name	Datatype	Description
api_key_infos	array	Api key infos
links	object	Links to other pages
meta	object	Meta information about the data set

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
genai_list_agent_api_keys	select	agent_uuid	page, per_page	To list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
genai_create_agent_api_key	insert	agent_uuid		To create an agent API key, send a POST request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
genai_update_agent_api_key	replace	agent_uuid, api_key_uuid		To update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
genai_delete_agent_api_key	delete	agent_uuid, api_key_uuid		To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
genai_regenerate_agent_api_key	exec	agent_uuid, api_key_uuid		To regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_uuid	string	Agent id (example: "123e4567-e89b-12d3-a456-426614174000")
api_key_uuid	string	API key ID (example: "123e4567-e89b-12d3-a456-426614174000")
page	integer	Page number. (example: 1)
per_page	integer	Items per page. (example: 1)

SELECT examples

genai_list_agent_api_keys

To list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.

SELECT
api_key_infos,
links,
meta
FROM digitalocean.genai.agent_api_keys
WHERE agent_uuid = '{{ agent_uuid }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}';

INSERT examples

genai_create_agent_api_key

To create an agent API key, send a POST request to /v2/gen-ai/agents/{agent_uuid}/api_keys.

INSERT INTO digitalocean.genai.agent_api_keys (
data__agent_uuid,
data__name,
agent_uuid
)
SELECT 
'{{ agent_uuid }}',
'{{ name }}',
'{{ agent_uuid }}'
RETURNING
api_key_info
;

Manifest

# Description fields are for documentation purposes
- name: agent_api_keys
  props:
    - name: agent_uuid
      value: string
      description: Required parameter for the agent_api_keys resource.
    - name: agent_uuid
      value: string
      description: >
        Agent id
        
    - name: name
      value: string
      description: >
        A human friendly name to identify the key
        

REPLACE examples

genai_update_agent_api_key

To update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

REPLACE digitalocean.genai.agent_api_keys
SET 
data__agent_uuid = '{{ agent_uuid }}',
data__api_key_uuid = '{{ api_key_uuid }}',
data__name = '{{ name }}'
WHERE 
agent_uuid = '{{ agent_uuid }}' --required
AND api_key_uuid = '{{ api_key_uuid }}' --required
RETURNING
api_key_info;

DELETE examples

genai_delete_agent_api_key

To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

DELETE FROM digitalocean.genai.agent_api_keys
WHERE agent_uuid = '{{ agent_uuid }}' --required
AND api_key_uuid = '{{ api_key_uuid }}' --required;

Lifecycle Methods

genai_regenerate_agent_api_key

To regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate.

EXEC digitalocean.genai.agent_api_keys.genai_regenerate_agent_api_key 
@agent_uuid='{{ agent_uuid }}' --required, 
@api_key_uuid='{{ api_key_uuid }}' --required;