Skip to content

KitchenOwl v114

WIP KitchenOwl API documentation

Terms of service: https://kitchenowl.org/privacy/
Contact: API Support support@kitchenowl.org
License: AGPL 3.0

Servers

Description URL
Official KitchenOwl server instance https://app.kitchenowl.org/api

Endpoints

DELETE /api/auth

User logout

Input parameters

Parameter In Type Default Nullable Description
bearerAuth header string N/A No JWT Bearer token
id path integer No Token ID to revoke (default: current token)

Response 200 OK 

{
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "msg": {
            "type": "string"
        }
    },
    "type": "object"
}

Response 401 Unauthorized

POST /api/auth

User login

Request body

{
    "device": "string",
    "password": "string",
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "properties": {
        "device": {
            "type": "string",
            "writeOnly": true
        },
        "password": {
            "type": "string",
            "writeOnly": true
        },
        "username": {
            "type": "string"
        }
    },
    "required": [
        "password",
        "username"
    ],
    "type": "object"
}

Response 200 OK 

{
    "access_token": "string",
    "refresh_token": "string",
    "user": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "access_token": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        },
        "user": {
            "type": "object"
        }
    },
    "type": "object"
}

Response 400 Bad Request

Response 401 Unauthorized

POST /api/auth/llt

Create long-lived token

Input parameters

Parameter In Type Default Nullable Description
bearerAuth header string N/A No JWT Bearer token

Request body

{
    "device": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "properties": {
        "device": {
            "type": "string",
            "writeOnly": true
        }
    },
    "required": [
        "device"
    ],
    "type": "object"
}

Response 200 OK 

{
    "longlived_token": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "longlived_token": {
            "type": "string"
        }
    },
    "type": "object"
}

Response 401 Unauthorized

DELETE /api/auth/llt/{id}

Delete long-lived token

Input parameters

Parameter In Type Default Nullable Description
bearerAuth header string N/A No JWT Bearer token
id path integer No Token ID to revoke

Response 200 OK 

{
    "msg": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "msg": {
            "type": "string"
        }
    },
    "type": "object"
}

Response 401 Unauthorized

GET /api/auth/refresh

Token refresh

Input parameters

Parameter In Type Default Nullable Description
bearerRefreshToken header string N/A No JWT Bearer token

Response 200 OK 

{
    "access_token": "string",
    "refresh_token": "string",
    "user": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "access_token": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        },
        "user": {
            "type": "object"
        }
    },
    "type": "object"
}

Response 401 Unauthorized

POST /api/auth/signup

User registration

Request body

{
    "device": "string",
    "email": "string",
    "name": "string",
    "password": "string",
    "username": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
{
    "properties": {
        "device": {
            "type": "string",
            "writeOnly": true
        },
        "email": {
            "type": "string",
            "writeOnly": true
        },
        "name": {
            "type": "string"
        },
        "password": {
            "type": "string",
            "writeOnly": true
        },
        "username": {
            "type": "string"
        }
    },
    "required": [
        "email",
        "name",
        "password",
        "username"
    ],
    "type": "object"
}

Response 200 OK 

{
    "access_token": "string",
    "refresh_token": "string",
    "user": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "access_token": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        },
        "user": {
            "type": "object"
        }
    },
    "type": "object"
}

Response 400 Bad Request

Schemas

CreateLongLivedToken

Name Type
device string

Login

Name Type
device string
password string
username string

Signup

Name Type
device string
email string
name string
password string
username string

Security schemes

Name Type Scheme Description
bearerAuth http bearer
bearerRefreshToken http bearer

More documentation

Find more info at the official documentation

For more information: https://docs.kitchenowl.org