Skip to content
  • Auto
  • Light
  • Dark

Regenerate

Regenerate API Key for an Agent
agents.api_keys.regenerate(strapi_key_uuid, APIKeyRegenerateParams**kwargs) -> api_key_infoAPIAgentAPIKeyInfoAPIKeyRegenerateResponse
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate

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

Parameters
agent_uuidstr
api_key_uuidstr
Returns
APIKeyRegenerateResponseclass
Hide ParametersShow Parameters
api_key_infoAPIAgentAPIKeyInfo
optional

Agent API Key Info

from do_gradientai import GradientAI

client = GradientAI()
response = client.agents.api_keys.regenerate(
    api_key_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
    agent_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(response.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\""
  }
}