---
title: "Creates agent key."
method: POST
path: "/agents/keys"
tags: ["Agents"]
---

# Creates agent key.

`POST /agents/keys`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/agents/keys`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/agents/keys/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates agent key.

## Request body

- CreateAgentKeyRequest
  - `name` string, required
  - `type` 'private' | 'shared', required
  - `value` string, required
  - `description` string

## Response `200`

Successful operation

- AgentKey
  - `id` string
  - `name` string, required
  - `type` 'private' | 'shared' | 'built_in', required
  - `description` string
  - `created_at` string
  - `updated_at` string
  - `owner_email` string

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Invalid or missing API key
- `409`: Conflict
- `500`: Internal server error
- `default`: Unexpected error

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)