Update

API Reference

Agents

API Keys

Update API Key for an Agent

agents.api_keys.update(strpath_api_key_uuid, APIKeyUpdateParams**kwargs) -> APIKeyUpdateResponse

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{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}.

ParametersExpand Collapse

agent_uuid: str

api_key_uuid: str

agent_uuid: str

api_key_uuid: str

name: Optional[str]

Name

ReturnsExpand Collapse

class APIKeyUpdateResponse: …

api_key_info: Optional[APIAgentAPIKeyInfo]

Agent API Key Info

HTTPPython

from gradient import Gradient

client = Gradient()
api_key = client.agents.api_keys.update(
    path_api_key_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
    path_agent_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(api_key.api_key_info)

200 example

{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Returns Examples

200 example

{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}