Skip to content
autom8y

Create Api Key

POST
/auth/api-keys

Create a new API key.

API keys are only returned once on creation. Users must store them securely. The key is hashed with Argon2id before storage.

Args: request: API key creation details user_payload: Authenticated user payload db: Database session

Returns: Created API key with plaintext key (only shown once)

Raises: 400: Business not found or user not associated with business

Request Body required

Section titled “Request Body required ”
CreateAPIKeyRequest

Create API key request.

object
name
required
Name

API key name

string
>= 1 characters <= 255 characters
scopes
Scopes

Scopes for the key

Array<string>
business_id
required
Business Id

Business/tenant UUID

string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

APIKeyResponse

API key response.

object
id
required
Id
string
name
required
Name
string
key
Any of:
string
scopes
Scopes
Array<string>
default:
created_at
required
Created At
string format: date-time
revoked_at
Any of:
string format: date-time
last_used_at
Any of:
string format: date-time

400

Section titled “400 ”

Bad Request

ErrorResponse

Error response.

object
error
required
Error

Error code

string
message
required
Message

Error message

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object