api_keys

Create a new API key.

Args: params: The parameters for creating the API key.

Returns: ApiKeyCreated: The response containing the details of the created API key.

post/v1/api-keys

Request

  • Base URL
    https://api.mixedbread.com
  • URL
    https://api.mixedbread.com/v1/api-keys
  • Auth
    HTTP bearer

Request body

namestring

A name/description for the API key

expires_atstring date-time nullable

Optional expiration datetime

Response

The created API key details

idstring required

The ID of the API key

namestring required

The name of the API key

redacted_valuestring required

The redacted value of the API key

expires_atstring date-time nullable

The expiration datetime of the API key

created_atstring date-time required

The creation datetime of the API key

updated_atstring date-time required

The last update datetime of the API key

last_active_atstring date-time nullable

The last active datetime of the API key

object'api_key'

The type of the object

valuestring required

The value of the API key

Changes

    • info

      added the new optional request property ///

    • info

      added the optional property /// to the response with the status

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      the response property const value store was removed for the status

    • warning

      added the new completions enum value to the //// response property for the response status

    • warning

      added the new store enum value to the //// response property for the response status

    • info

      the request property const value store was removed

    • info

      added the new completions enum value to the request property ////

    • info

      added the new store enum value to the request property ////