nlqdb API

nlqdb API as documented publicly: 27 operations. Contract generated from the documentation by API Evangelist (2026-11-19); not the provider's own document.

GitHub OpenAPI

Operations 27

POST /v1/ask POST /v1/ask — the canonical NL→SQL endpoint. #
POST /v1/attach POST /v1/attach — attach the Postgres or D1 a team already has ( GLOBAL-043 ). #
GET /v1/chat/messages listChat() – the caller’s persisted chat turns, oldest first. #
POST /v1/chat/messages POST /v1/chat/messages — chat-style transcript endpoint. #
GET /v1/databases GET /v1/databases — list databases. #
POST /v1/databases POST /v1/databases — create a database from a plain-English brief. #
DELETE /v1/databases/{id} DELETE /v1/databases/:id — destructive removal ( SK-HDC-016 ). #
GET /v1/databases/{id}/changes GET /v1/databases/:id/changes — every schema change the DBA made on a database, newest first, each with its inverse. #
POST /v1/db/connect POST /v1/db/connect — connect a bring-your-own Postgres / ClickHouse ( SK-DBCONN-001 ). #
GET /v1/grants listGrants() – the caller’s grants ( SK-EKP-008 ), both roles in one list. #
POST /v1/grants mint request. #
DELETE /v1/grants/{id} DELETE /v1/grants/:id response. #
POST /v1/insert POST /v1/insert — insert JSON rows exactly as sent, no model call; an unseen table or field is created. #
GET /v1/keys GET /v1/keys — API-key lifecycle. #
POST /v1/keys POST /v1/keys mint. #
GET /v1/keys/{hash}/status DO revalidation probe. #
DELETE /v1/keys/{id} DELETE /v1/keys/:id — API-key lifecycle. #
GET /v1/keys/byollm GET /v1/keys/byollm #
POST /v1/keys/byollm setByollm() #
POST /v1/memory/remember remember() – write a typed memory row into an agent_memory_v1 preset DB. #
GET /v1/models the model catalog served by GET /v1/models. #
POST /v1/oauth/mcp-callback cross‑Worker bridge. #
POST /v1/oauth/mcp-callback/redeem redeemOAuthBridgeCode() – redeem the one-shot OAuth-bridge code. #
POST /v1/premium/interest registerPremiumInterest() – record a “count me in” for the hosted-premium plan. #
POST /v1/proposals/{id}/apply POST /v1/proposals/:id/apply — run a proposal’s DDL on the attached DB ( GLOBAL-043 item 5); id is the one attach() / listChanges gave. #
POST /v1/proposals/{id}/reject rejectProposal() – decline a proposal, with an optional reason. #
POST /v1/run POST /v1/run — raw-SQL escape hatch ( GLOBAL-015 ). #

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/nlqdb-com:nlqdb-com-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

nlqdb-com-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: nlqdb API
  version: '2026-11-19'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-19: 27 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; nlqdb has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 27
    pages-with-code: 0
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-19'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.nlqdb.com/reference/sdk
  - https://docs.nlqdb.com/reference/http-api
  - https://docs.nlqdb.com/reference/sdk/type-aliases/keystatus
  - https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
paths:
  /v1/ask:
    post:
      operationId: post_v1_ask
      tags:
      - Ask
      summary: POST /v1/ask — the canonical NL→SQL endpoint.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/attach:
    post:
      operationId: post_v1_attach
      tags:
      - Attach
      summary: POST /v1/attach — attach the Postgres or D1 a team already has ( GLOBAL-043 ).
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AttachRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1AttachResponse'
      x-evidence:
        kind: documentation
  /v1/chat/messages:
    get:
      operationId: get_v1_chat_messages
      tags:
      - Chat
      summary: listChat() – the caller’s persisted chat turns, oldest first.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: signal
        in: query
        required: false
        schema:
          type: string
        description: AbortSignal
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ChatMessagesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_chat_messages
      tags:
      - Chat
      summary: POST /v1/chat/messages — chat-style transcript endpoint.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/databases:
    get:
      operationId: get_v1_databases
      tags:
      - Databases
      summary: GET /v1/databases — list databases.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_databases
      tags:
      - Databases
      summary: POST /v1/databases — create a database from a plain-English brief.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/databases/{id}:
    delete:
      operationId: delete_v1_databases_id
      tags:
      - Databases
      summary: DELETE /v1/databases/:id — destructive removal ( SK-HDC-016 ).
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/databases/{id}/changes:
    get:
      operationId: get_v1_databases_id_changes
      tags:
      - Databases
      summary: GET /v1/databases/:id/changes — every schema change the DBA made on a database, newest first, each with its inverse.
      x-source: https://docs.nlqdb.com/reference/http-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/db/connect:
    post:
      operationId: post_v1_db_connect
      tags:
      - Db
      summary: POST /v1/db/connect — connect a bring-your-own Postgres / ClickHouse ( SK-DBCONN-001 ).
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1DbConnectRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1DbConnectResponse'
      x-evidence:
        kind: documentation
  /v1/grants:
    get:
      operationId: get_v1_grants
      tags:
      - Grants
      summary: listGrants() – the caller’s grants ( SK-EKP-008 ), both roles in one list.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: signal
        in: query
        required: false
        schema:
          type: string
        description: AbortSignal
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1GrantsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_grants
      tags:
      - Grants
      summary: mint request.
      x-source: https://docs.nlqdb.com/reference/sdk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1GrantsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1GrantsResponse'
      x-evidence:
        kind: documentation
  /v1/grants/{id}:
    delete:
      operationId: delete_v1_grants_id
      tags:
      - Grants
      summary: DELETE /v1/grants/:id response.
      x-source: https://docs.nlqdb.com/reference/sdk
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV1GrantsIdResponse'
      x-evidence:
        kind: documentation
  /v1/insert:
    post:
      operationId: post_v1_insert
      tags:
      - Insert
      summary: POST /v1/insert — insert JSON rows exactly as sent, no model call; an unseen table or field is created.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/keys:
    get:
      operationId: get_v1_keys
      tags:
      - Keys
      summary: GET /v1/keys — API-key lifecycle.
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_keys
      tags:
      - Keys
      summary: POST /v1/keys mint.
      x-source: https://docs.nlqdb.com/reference/sdk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1KeysRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1KeysResponse'
      x-evidence:
        kind: documentation
  /v1/keys/{hash}/status:
    get:
      operationId: get_v1_keys_hash_status
      tags:
      - Keys
      summary: DO revalidation probe.
      x-source: https://docs.nlqdb.com/reference/sdk
      parameters:
      - name: hash
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1KeysHashStatusResponse'
      x-evidence:
        kind: documentation
  /v1/keys/{id}:
    delete:
      operationId: delete_v1_keys_id
      tags:
      - Keys
      summary: DELETE /v1/keys/:id — API-key lifecycle.
      x-source: https://docs.nlqdb.com/reference/http-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/keys/byollm:
    get:
      operationId: get_v1_keys_byollm
      tags:
      - Keys
      summary: GET /v1/keys/byollm
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1KeysByollmResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_keys_byollm
      tags:
      - Keys
      summary: setByollm()
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: idempotencyKey
        in: query
        required: false
        schema:
          type: string
      - name: signal
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1KeysByollmRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1KeysByollmResponse'
      x-evidence:
        kind: documentation
  /v1/memory/remember:
    post:
      operationId: post_v1_memory_remember
      tags:
      - Memory
      summary: remember() – write a typed memory row into an agent_memory_v1 preset DB.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1MemoryRememberRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1MemoryRememberResponse'
      x-evidence:
        kind: documentation
  /v1/models:
    get:
      operationId: get_v1_models
      tags:
      - Models
      summary: the model catalog served by GET /v1/models.
      x-source: https://docs.nlqdb.com/reference/sdk
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ModelsResponse'
      x-evidence:
        kind: documentation
  /v1/oauth/mcp-callback:
    post:
      operationId: post_v1_oauth_mcp_callback
      tags:
      - Oauth
      summary: cross‑Worker bridge.
      x-source: https://docs.nlqdb.com/reference/sdk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1OauthMcpCallbackRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1OauthMcpCallbackResponse'
      x-evidence:
        kind: documentation
  /v1/oauth/mcp-callback/redeem:
    post:
      operationId: post_v1_oauth_mcp_callback_redeem
      tags:
      - Oauth
      summary: redeemOAuthBridgeCode() – redeem the one-shot OAuth-bridge code.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1OauthMcpCallbackRedeemRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1OauthMcpCallbackRedeemResponse'
      x-evidence:
        kind: documentation
  /v1/premium/interest:
    post:
      operationId: post_v1_premium_interest
      tags:
      - Premium
      summary: registerPremiumInterest() – record a “count me in” for the hosted-premium plan.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1PremiumInterestRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1PremiumInterestResponse'
      x-evidence:
        kind: documentation
  /v1/proposals/{id}/apply:
    post:
      operationId: post_v1_proposals_id_apply
      tags:
      - Proposals
      summary: POST /v1/proposals/:id/apply — run a proposal’s DDL on the attached DB ( GLOBAL-043 item 5); id is the one attach() / listChanges
        gave.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ProposalsIdApplyResponse'
      x-evidence:
        kind: documentation
  /v1/proposals/{id}/reject:
    post:
      operationId: post_v1_proposals_id_reject
      tags:
      - Proposals
      summary: rejectProposal() – decline a proposal, with an optional reason.
      x-source: https://docs.nlqdb.com/reference/sdk/type-aliases/nlqclient
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ProposalsIdRejectRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ProposalsIdRejectResponse'
      x-evidence:
        kind: documentation
  /v1/run:
    post:
      operationId: post_v1_run
      tags:
      - Run
      summary: POST /v1/run — raw-SQL escape hatch ( GLOBAL-015 ).
      x-source: https://docs.nlqdb.com/reference/http-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1AttachRequest:
      type: object
      properties:
        req:
          type: string
          description: Attach request payload.
      required:
      - req
    PostV1AttachResponse:
      type: object
      properties:
        ConnectDatabaseResult:
          type: object
          description: Result of attaching the database.
    GetV1ChatMessagesResponse:
      type: object
      properties:
        messages:
          type: array
          description: ChatMessage[]
    PostV1DbConnectRequest:
      type: object
      properties:
        connectionUrl:
          type: string
          description: The connection URL rides the request body only.
      required:
      - connectionUrl
    PostV1DbConnectResponse:
      type: object
      properties:
        ConnectDatabaseResult:
          type: object
          description: Result of connecting the database.
    GetV1GrantsResponse:
      type: object
      properties:
        grants:
          type: array
          description: GrantRecord[]
    PostV1GrantsRequest:
      type: object
      properties:
        MintGrantRequest:
          type: string
          description: The cross‑tenant read‑grant control plane request.
      required:
      - MintGrantRequest
    PostV1GrantsResponse:
      type: object
      properties:
        GrantMintResult:
          type: string
          description: mintGrant() result — the minted grant, always active.
    DeleteV1GrantsIdResponse:
      type: object
      properties:
        RevokeGrantResult:
          type: string
          description: DELETE /v1/grants/:id response. Idempotent.
    PostV1KeysRequest:
      type: object
      properties:
        MintKeyRequest:
          type: string
          description: Request body for minting a new key.
      required:
      - MintKeyRequest
    PostV1KeysResponse:
      type: object
      properties:
        MintKeyResult:
          type: string
          description: Response from client.mintKey() — the plaintext key is present here exactly once.
    GetV1KeysHashStatusResponse:
      type: object
      properties:
        KeyStatus:
          type: string
          description: Result of the revalidation probe.
    GetV1KeysByollmResponse:
      type: object
      properties:
        ByollmStatusResponse:
          type: object
          description: Status response.
    PostV1KeysByollmRequest:
      type: object
      properties:
        cred:
          type: string
      required:
      - cred
    PostV1KeysByollmResponse:
      type: object
      properties:
        ByollmSetResult:
          type: object
    PostV1MemoryRememberRequest:
      type: object
      properties:
        req:
          type: string
        idempotencyKey:
          type: string
        signal:
          type: string
      required:
      - req
    PostV1MemoryRememberResponse:
      type: object
      properties:
        result:
          type: string
    GetV1ModelsResponse:
      type: object
      properties:
        ModelCatalog:
          type: string
          description: The model catalog.
    PostV1OauthMcpCallbackRequest:
      type: object
      properties:
        OAuthBridgeRedemption:
          type: string
          description: Redemption payload for the MCP OAuth bridge.
      required:
      - OAuthBridgeRedemption
    PostV1OauthMcpCallbackResponse:
      type: object
      properties:
        OAuthBridgeRedemption:
          type: string
          description: Response payload for the bridge redemption.
    PostV1OauthMcpCallbackRedeemRequest:
      type: object
      properties:
        code:
          type: string
        signal:
          type: string
      required:
      - code
    PostV1OauthMcpCallbackRedeemResponse:
      type: object
      properties:
        result:
          type: string
    PostV1PremiumInterestRequest:
      type: object
      properties:
        idempotencyKey:
          type: string
        signal:
          type: string
    PostV1PremiumInterestResponse:
      type: object
      properties:
        result:
          type: string
    PostV1ProposalsIdApplyResponse:
      type: object
      properties:
        DecideProposalResult:
          type: object
          description: Result of applying the proposal.
    PostV1ProposalsIdRejectRequest:
      type: object
      properties:
        reason:
          type: string
        signal:
          type: string
    PostV1ProposalsIdRejectResponse:
      type: object
      properties:
        result:
          type: string
tags:
- name: Ask
- name: Attach
- name: Chat
- name: Databases
- name: Db
- name: Grants
- name: Insert
- name: Keys
- name: Memory
- name: Models
- name: Oauth
- name: Premium
- name: Proposals
- name: Run