Create API key (Admin)
POST
/admin/api-keys
const url = 'https://firma.company-gpt.com/companygpt/rag/api/admin/api-keys';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"clientName":"example","permissions":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://firma.company-gpt.com/companygpt/rag/api/admin/api-keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "clientName": "example", "permissions": [ "example" ] }'Create a new API key for a user or application
Authorizations
Abschnitt betitelt „Authorizations“Request Bodyrequired
Abschnitt betitelt „Request Bodyrequired“Media typeapplication/json
object
clientName
required
Human-readable name for this API key
string
permissions
Requested permissions (default: [‘read’])
Array<string>
Examplegenerated
{ "clientName": "example", "permissions": [ "example" ]}Responses
Abschnitt betitelt „Responses“API key created (key shown only once)
Media typeapplication/json
Response for POST /admin/api-keys. The raw key is shown only once and is never stored or returned again.
object
id
required
string format: uuid
key
required
The actual API key (shown only once)
string
clientName
required
string
permissions
required
Array<string>
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "key": "example", "clientName": "example", "permissions": [ "example" ]}Invalid request
Media typeapplication/json
object
error
required
Error message
string
Examplegenerated
{ "error": "example"}Unauthorized
Admin access required