Lokki

Lokki Document Model API

The Document Model API from Lokki — 3 operation(s) for document model.

GitHub OpenAPI

Operations 5

GET /v2/document-model/byCompany #
GET /v2/document-model/{documentModelId} #
PUT /v2/document-model/{documentModelId} #
DELETE /v2/document-model/{documentModelId} #
POST /v2/document-model #

Documentation

📖
Documentation
https://docs.getlokki.com/
📖
APIReference
https://docs.getlokki.com/api-reference/getting-started
📖
GettingStarted
https://docs.getlokki.com/api-reference/getting-started
📖
Authentication
https://docs.getlokki.com/api-reference/authentication
📖
Documentation
https://prod.api.eu-west-3.lokki.rent/v2/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/openapi/lokki-document-model-api-openapi.yml

Other Resources

🔗
Deprecation
https://docs.getlokki.com/api-reference/stores/deprecations
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/data-model/lokki-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/errors/lokki-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lokki-document-model-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lokki-document-model-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lokki Document Model API
  description: The main API powering the Lokki Dashboard and Online Store
  version: '2.0'
  contact: {}
servers: []
security:
- x-access-token: []
tags:
- name: Document Model
paths:
  /v2/document-model/byCompany:
    get:
      operationId: getDocumentModelsByCompany
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentModel'
      tags:
      - Document Model
  /v2/document-model/{documentModelId}:
    get:
      operationId: getDocumentModelById
      parameters:
      - name: documentModelId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModel'
      tags:
      - Document Model
    put:
      operationId: updateDocumentModel
      parameters:
      - name: documentModelId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDocumentModelDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModel'
      tags:
      - Document Model
    delete:
      operationId: deleteDocumentModelsById
      parameters:
      - name: documentModelId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - Document Model
  /v2/document-model:
    post:
      operationId: createDocumentModel
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentModelDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModel'
      tags:
      - Document Model
components:
  schemas:
    CreateDocumentModelDto:
      type: object
      properties:
        name:
          type: string
        companyId:
          type: string
        legalMentions:
          type: string
        signature:
          type: boolean
        onlineProductsName:
          type: boolean
        addComment:
          type: boolean
        termsAndConditions:
          type: boolean
        displayProductImage:
          type: boolean
        sortItemsByType:
          type: boolean
        sortItemsAlphabetically:
          type: boolean
        displayProductDescription:
          type: boolean
        onlineStore:
          type: boolean
        isWorkshop:
          type: boolean
        displaySubProducts:
          type: boolean
        hideTime:
          type: boolean
        hideDate:
          type: boolean
        hidePrice:
          type: boolean
        useLegalCompanyInfo:
          type: boolean
      required:
      - name
      - companyId
      - legalMentions
      - signature
      - onlineProductsName
      - addComment
      - termsAndConditions
      - displayProductImage
      - sortItemsByType
      - sortItemsAlphabetically
      - displayProductDescription
      - onlineStore
      - isWorkshop
      - displaySubProducts
      - hideTime
      - hideDate
      - hidePrice
    DocumentModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        companyId:
          type: string
        legalMentions:
          type: string
        signature:
          type: boolean
        onlineProductsName:
          type: boolean
        addComment:
          type: boolean
        termsAndConditions:
          type: boolean
        numberCreated:
          type: number
        onlineStore:
          type: boolean
        isWorkshop:
          type: boolean
        displaySubProducts:
          type: boolean
        displayProductImage:
          type: boolean
        sortItemsByType:
          type: boolean
        sortItemsAlphabetically:
          type: boolean
        displayProductDescription:
          type: boolean
        hideTime:
          type: boolean
        hideDate:
          type: boolean
        hidePrice:
          type: boolean
        useLegalCompanyInfo:
          type: boolean
        createdAt:
          format: date-time
          type: string
      required:
      - id
      - name
      - companyId
      - legalMentions
      - signature
      - onlineProductsName
      - addComment
      - termsAndConditions
      - numberCreated
      - onlineStore
      - isWorkshop
      - displaySubProducts
      - displayProductImage
      - sortItemsByType
      - sortItemsAlphabetically
      - displayProductDescription
      - hideTime
      - hideDate
      - hidePrice
      - useLegalCompanyInfo
      - createdAt
    UpdateDocumentModelDto:
      type: object
      properties:
        name:
          type: string
        legalMentions:
          type: string
        signature:
          type: boolean
        onlineProductsName:
          type: boolean
        addComment:
          type: boolean
        termsAndConditions:
          type: boolean
        displayProductImage:
          type: boolean
        sortItemsByType:
          type: boolean
        sortItemsAlphabetically:
          type: boolean
        displayProductDescription:
          type: boolean
        onlineStore:
          type: boolean
        isWorkshop:
          type: boolean
        displaySubProducts:
          type: boolean
        hideTime:
          type: boolean
        hideDate:
          type: boolean
        hidePrice:
          type: boolean
        useLegalCompanyInfo:
          type: boolean
      required:
      - name
      - legalMentions
      - signature
      - onlineProductsName
      - addComment
      - termsAndConditions
      - displayProductImage
      - sortItemsByType
      - sortItemsAlphabetically
      - displayProductDescription
      - onlineStore
      - isWorkshop
      - displaySubProducts
      - hideTime
      - hideDate
      - hidePrice
      - useLegalCompanyInfo
  securitySchemes:
    x-access-token:
      scheme: bearer
      bearerFormat: JWT
      type: apiKey
      in: header
      name: x-access-token