Create an API key

Allows admins to create an API key for another user.

post/admin/api_keys

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/admin/api_keys/post.ts
A function with typed inputs. Its response is checked against the schema.

user_idstring required

Id of the user the key will be created for

namestring

The name for the API key

collection_idstring

The id of the collection you want the key to be configured to

expires_instring

Interval of when the API key should expire

inactivity_intervalinteger

The number of days a key can be unused for (no activity) before it becomes invalid.

{
  "expires_in": "30 days",
  "inactivity_interval": 60
}

Successful operation

secret_keystring required

The secret key associated with the newly generated API Key.

No recorded changes to this operation across all 1 revision of this API.