Create Api Key

Create a new API key for the current user.

Returns a temporary plain key for the user to store securely. This is not stored in the database.

Args:

db (AsyncSession): The database session. api_key_in (schemas.APIKeyCreate): The API key creation data. user (schemas.User): The current user.

schemas.APIKeyWithPlainKey: The created API key object, including the key.

This endpoint expects an object.

expiration_datedatetimeOptional

Expiration date for the API key, defaults to 180 days from now

Successful Response

idstringformat: "uuid"

key_prefixstring

organizationstringformat: "uuid"

created_atdatetime

modified_atdatetime

expiration_datedatetime

created_by_emailstringformat: "email"

modified_by_emailstringformat: "email"

plain_keystring

last_used_datedatetimeOptional

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.api_keys.create_api_key()

1	{
2	"id": "id",
3	"key_prefix": "key_prefix",
4	"organization": "organization",
5	"created_at": "2024-01-15T09:30:00Z",
6	"modified_at": "2024-01-15T09:30:00Z",
7	"expiration_date": "2024-01-15T09:30:00Z",
8	"created_by_email": "created_by_email",
9	"modified_by_email": "modified_by_email",
10	"plain_key": "plain_key",
11	"last_used_date": "2024-01-15T09:30:00Z"
12	}