Lockally Test API

Test mode (lk_test_* keys)

GitHub OpenAPI

Operations 1

POST /v1/test/inbound Simulate an inbound email (test keys only) #

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/lockally-com:lockally-com-test-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

lockally-com-test-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: lockally control plane Test API
  version: 0.1.0
  summary: REST API for managing tenants, domains, mailboxes, and outbound mail
  description: 'The lockally control plane lets integrators and direct customers manage

    everything except actual mail data flow (which uses standard JMAP / IMAP /

    SMTP-submission against the data plane endpoints).


    **Authentication.** All `/v1/*` endpoints require a Bearer API key in the

    `Authorization` header. Keys are formatted `lk_live__`,

    or `lk_test_` for a test key. Create keys in the dashboard, or with

    `POST /v1/api-keys` using a key that holds `tenant:admin`.


    The key''s plan is checked on every request, so a key stops working if the

    account moves to a plan without API access, and works again if it moves back.


    **Errors.** Failures return RFC 9457

    `application/problem+json` documents.


    **Scopes.** Each endpoint requires a specific scope on the presented key.

    Insufficient scope returns `403` with the required scope name in `detail`.'
  contact:
    name: lockally support
    email: support@lockally.com
  license:
    name: AGPL-3.0-only OR LicenseRef-LOC-Commercial
    identifier: AGPL-3.0-only
servers:
- url: https://api.lockally.com
  description: Production
- url: http://127.0.0.1:8081
  description: Local development / spike
security:
- bearerAuth: []
tags:
- name: Test
  description: Test mode (lk_test_* keys)
paths:
  /v1/test/inbound:
    post:
      operationId: simulateInboundEmail
      tags:
      - Test
      summary: Simulate an inbound email (test keys only)
      description: 'Runs a synthetic message through the REAL indexing pipeline, thread adoption, deterministic extraction (incl. injection_risk), and the message.received webhook, so the whole agent loop is testable without a real domain or MTA. Requires an lk_test_* key (create with {"test": true} on POST /v1/api-keys). Body: {mailbox, from, subject, text, in_reply_to?, references?}.'
      x-required-scope: inboxes:write
      responses:
        '201':
          description: Simulated message indexed (thread_id, annotations)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulatedInbound'
        '403':
          description: Live key used, test keys only
components:
  schemas:
    InjectionRisk:
      type: object
      properties:
        flagged:
          type: boolean
        signals:
          type: array
          items:
            type: string
          description: The phrases that tripped the check.
    Annotations:
      type: object
      description: 'Signals computed at ingest, before an agent sees the message. A key is absent when its check did not fire.

        '
      properties:
        attachment_types:
          type: array
          items:
            type: string
        meeting_request:
          type: boolean
        injection_risk:
          $ref: '#/components/schemas/InjectionRisk'
    SimulatedInbound:
      type: object
      properties:
        simulated:
          type: boolean
        indexed:
          type: boolean
          description: True when the message was adopted into a thread.
        thread_id:
          type: string
          format: uuid
        message_id:
          type: string
          format: uuid
        rfc_message_id:
          type: string
        annotations:
          $ref: '#/components/schemas/Annotations'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_live_<prefix>_<secret>
      description: API key, format `lk_live_<8-char-prefix>_<32-char-secret>`.
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 (authorization code + PKCE). The access token is sent as the

        `Authorization: Bearer` credential, exactly like an API key, so any SDK

        that accepts a bearer token works with OAuth. Discovery:

        `/.well-known/oauth-authorization-server`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://api.lockally.com/oauth/authorize
          tokenUrl: https://api.lockally.com/oauth/token
          scopes:
            inboxes:read: Read agent-accessible mailboxes and threads
            inboxes:write: Send and act on agent-accessible mailboxes