Update API Key for an Agent

client.Agents.APIKeys.Update(ctx, agentUuid, apiKeyUuid, body) (*AgentAPIKeyUpdateResponse, error)

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

agentUuid string

apiKeyUuid string

body AgentAPIKeyUpdateParams

AgentUuid param.Field[string]optional

Agent id

APIKeyUuid param.Field[string]optional

API key ID

Name param.Field[string]optional

Name

ReturnsExpand Collapse

type AgentAPIKeyUpdateResponse struct{…}

APIKeyInfo APIAgentAPIKeyInfooptional

Agent API Key Info

CreatedAt Timeoptional

Creation date

formatdate-time

CreatedBy stringoptional

Created by

formatuint64

DeletedAt Timeoptional

Deleted date

formatdate-time

Name stringoptional

Name

SecretKey stringoptional

Uuid stringoptional

Uuid

Update API Key for an Agent

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  apiKey, err := client.Agents.APIKeys.Update(
    context.TODO(),
    `"123e4567-e89b-12d3-a456-426614174000"`,
    `"123e4567-e89b-12d3-a456-426614174000"`,
    gradient.AgentAPIKeyUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", apiKey.APIKeyInfo)
}

{
  "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

{
  "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"
  }
}