Skip to content
Get started

Generate API token

auth.api_keys.create(APIKeyCreateParams**kwargs) -> APIKeyCreateResponse
POST/api/auth/api-keys/

Create a new API token for the authenticated user.

ParametersExpand Collapse
project: str
formatuuid
name: Optional[str]
maxLength255
ReturnsExpand Collapse
class APIKeyCreateResponse:
id: str
formatuuid
created_at: datetime
formatdate-time
key: str

Plaintext secret. Shown only once.

name: str
prefix: str
Generate API token
from overmind_lab import OvermindLab

client = OvermindLab()
api_key = client.auth.api_keys.create(
    project="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(api_key.id)
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "key": "key",
  "name": "name",
  "prefix": "prefix"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "key": "key",
  "name": "name",
  "prefix": "prefix"
}