API Reference

Agents

API Keys

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create an Agent API Key

client.Agents.APIKeys.New(ctx, agentUuid, body) (*AgentAPIKeyNewResponse, error)

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

agentUuid string

body AgentAPIKeyNewParams

AgentUuid param.Field[string]optional

Agent id

Name param.Field[string]optional

A human friendly name to identify the key

ReturnsExpand Collapse

type AgentAPIKeyNewResponse 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

Create an Agent API Key

Go

HTTP

TypeScript

Python

Go

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.New(
    context.TODO(),
    `"123e4567-e89b-12d3-a456-426614174000"`,
    gradient.AgentAPIKeyNewParams{

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

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