PUT
/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}Update an agent API key
Replaces the configurable details of an API key for an agent. Use the agent and API key identifiers to select the key, and supply name in the optional request body to set its name. A 200 response returns the API key information.
agent_uuidstringrequired
The identifier of the agent whose API key you want to update.
api_key_uuidstringrequired
The identifier of the API key to update.
Optional API key update details.
agent_uuidstringoptional
Agent id
api_key_uuidstringoptional
API key ID
namestringoptional
Name
200Returns API key information, including its name, UUID, creation details, and secret key.
api_key_infoobjectoptional
Agent API Key Info
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested agent or API key is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
Error handling
A 401 is returned when authentication credentials are invalid. A 404 is returned when the agent or API key identified by the agent_uuid path parameter or api_key_uuid path parameter cannot be found. A 429 indicates that the API rate limit has been exceeded, and a 500 indicates a server error.