Create

API Reference

Agents

API Keys

Create an Agent API Key

agents.api_keys.create(strpath_agent_uuid, APIKeyCreateParams**kwargs) -> APIKeyCreateResponse

post/v2/gen-ai/agents/{agent_uuid}/api_keys

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

ParametersExpand Collapse

agent_uuid: str

agent_uuid: str

name: Optional[str]

A human friendly name to identify the key

ReturnsExpand Collapse

class APIKeyCreateResponse: …

api_key_info: Optional[APIAgentAPIKeyInfo]

Agent API Key Info

HTTPPython

from gradient import Gradient

client = Gradient()
api_key = client.agents.api_keys.create(
    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"
  }
}