v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

AiSecrets

Create ai_secret

Create a new ai_secret. If there is an existing ai_secret with the same name as the one specified in the request, will return the existing ai_secret unmodified

post/v1/ai_secret

Request body

namestring required

Name of the AI secret

typestring nullable

metadataobject nullable

secretstring nullable

Secret value. If omitted in a PUT request, the existing secret value will be left intact, not replaced with null.

org_namestring nullable

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the AI Secret belongs in.

Response

Returns the new ai_secret object

idstring uuid required

Unique identifier for the AI secret

createdstring date-time nullable

Date of AI secret creation

org_idstring uuid required

Unique identifier for the organization

namestring required

Name of the AI secret

typestring nullable

metadataobject nullable

preview_secretstring nullable