openkrill-app API

openapi: 3.1.0
info:
  title: openkrill-app API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 18 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; openkrill-app has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 15
    pages-with-code: 7
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://tools.openkrill.app/tools/sharelink
  - https://tools.openkrill.app/x-scraper-tutorial
  - https://tools.openkrill.app/llms.txt
  - https://tools.openkrill.app/index.md
  - https://tools.openkrill.app/llms-full.txt
  - https://tools.openkrill.app/newsletter
  - https://tools.openkrill.app/mirror
servers:
- url: https://api.openkrill.app
paths:
  /docsort/sort:
    post:
      operationId: post_docsort_sort
      tags:
      - Docsort
      summary: POST https://tools.openkrill.app/docsort/sort with form fields text, optional open_invoices_csv and as_of, or the same JSON the
        tool takes.
      description: Sort a business email or PDF into categories; returns fields per class and optional invoice matching.
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: text
        in: query
        required: true
        schema:
          type: string
        description: The document text to sort.
      - name: open_invoices_csv
        in: query
        required: false
        schema:
          type: string
        description: Optional CSV of open invoices for matching.
      - name: as_of
        in: query
        required: false
        schema:
          type: string
        description: Optional date reference.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDocsortSortRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /library/pull.mjs:
    get:
      operationId: get_library_pull_mjs
      tags:
      - Library
      summary: 'Pull tool, one file for Node 18 or newer: `curl -O https://tools.openkrill.app/library/pull.mjs`.'
      description: Download the asset library pull script.
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mcp:
    get:
      operationId: get_mcp
      tags:
      - Mcp
      summary: GET /mcp
      x-source: https://tools.openkrill.app/tools/sharelink
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl or Aria2, and list a Baidu share. \n Price Free API key None Limit 60 calls a minute Tools 2 \n Ask your assistant Give\
          \ me a direct download link for this Google Drive file. \n What it does \n Turns a Google Drive file, folder or Docs link into direct\
          \ download URLs with name and size Lists the files in a Baidu Netdisk share, with or without an extraction code Gives curl, aria2c and\
          \ Aria2 or Motri"
  /mirror/read:
    get:
      operationId: get_mirror_read
      tags:
      - Mirror
      summary: 'For agents: read a task back over HTTP'
      description: Send a JSON payload with a task (and optional notes) to obtain a reading of the task. The response contains the model's understanding,
        with glowing parts indicating missing or guessed content.
      x-source: https://tools.openkrill.app/mirror
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_mirror_read
      tags:
      - Mirror
      summary: 'POST https://tools.openkrill.app/mirror/read with JSON {"task": "...", "notes": [{"part": "...", "correction": "..."}]}.'
      description: Read back a task for verification; limits 6 readings a minute and 30 a day per network.
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: task
        in: query
        required: true
        schema:
          type: string
        description: The task text, 8 to 1,000 characters.
      - name: notes
        in: query
        required: false
        schema:
          type: string
        description: Optional array (max 6) of correction notes.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMirrorReadRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /oauth/register:
    post:
      operationId: post_oauth_register
      tags:
      - Oauth
      summary: dynamic client registration for OAuth
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/credits:
    get:
      operationId: get_v1_credits
      tags:
      - Credits
      summary: shows the balance and the ways to pay
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/credits/paypal/capture:
    post:
      operationId: post_v1_credits_paypal_capture
      tags:
      - Credits
      summary: capture a PayPal credit pack order (requires x-api-key and order id)
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/credits/paypal/order:
    post:
      operationId: post_v1_credits_paypal_order
      tags:
      - Credits
      summary: create a PayPal credit pack order (requires x-api-key)
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/credits/polar/order:
    post:
      operationId: post_v1_credits_polar_order
      tags:
      - Credits
      summary: create a Polar credit pack order (requires x-api-key)
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/feedback:
    post:
      operationId: post_v1_feedback
      tags:
      - Feedback
      summary: submit feedback (kind, message, optional tool)
      x-source: https://tools.openkrill.app/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1FeedbackRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1FeedbackResponse'
      x-evidence:
        kind: documentation
  /v1/feedback/{ticket}:
    get:
      operationId: get_v1_feedback_ticket
      tags:
      - Feedback
      summary: get feedback reply (status and optional reply)
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: ticket
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1FeedbackTicketResponse'
      x-evidence:
        kind: documentation
  /v1/jobs/{id}:
    get:
      operationId: get_v1_jobs_id
      tags:
      - Jobs
      summary: result of a slow request that was answered with HTTP 202
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/tools:
    get:
      operationId: get_v1_tools
      tags:
      - Tools
      summary: list the tools with their input schemas
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/tools/job-boards/run:
    get:
      operationId: get_v1_tools_job_boards_run
      tags:
      - Tools
      summary: GET /v1/tools/job-boards/run
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: companies
        in: query
        required: false
        schema:
          type: string
      - name: keyword
        in: query
        required: false
        schema:
          type: string
      - name: maxJobsPerCompany
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "x-api-key: $KEY" "https://api.openkrill.app/v1/tools/job-boards/run?companies=greenhouse:airbnb&keyword=engineer&maxJobsPerCompany=5"

          ```'
  /v1/tools/{name}/run:
    post:
      operationId: post_v1_tools_name_run
      tags:
      - Tools
      summary: run a tool (POST takes a JSON body)
      x-source: https://tools.openkrill.app/llms.txt
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/usage:
    get:
      operationId: get_v1_usage
      tags:
      - Usage
      summary: needs an API key; billable items delivered to your API key this month
      x-source: https://tools.openkrill.app/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/acts/openkrill~x-twitter-scraper/run-sync-get-dataset-items:
    post:
      operationId: post_v2_acts_openkrill_x_twitter_scraper_run_sync_get_dataset_items
      tags:
      - Acts
      summary: POST /v2/acts/openkrill~x-twitter-scraper/run-sync-get-dataset-items
      x-source: https://tools.openkrill.app/x-scraper-tutorial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2ActsOpenkrillXTwitterScraperRunSyncGetDatasetItemsRequ'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\"https://api.apify.com/v2/acts/openkrill~x-twitter-scraper/run-sync-get-dataset-items\", {\n method: \"POST\",\n headers:\
          \ { \"Content-Type\": \"application/json\", Authorization: `Bearer ${process.env.APIFY_TOKEN}` },\n body: JSON.stringify({ mode: \"\
          profile\", handles: [\"NASA\", \"golang\", \"github\"] })"
components:
  schemas:
    PostDocsortSortRequest:
      type: object
      properties:
        text:
          type: string
        open_invoices_csv:
          type: string
        as_of:
          type: string
      required:
      - text
    PostMirrorReadRequest:
      type: object
      properties:
        task:
          type: string
        notes:
          type: array
          description: Objects with part and correction strings.
      required:
      - task
    PostV1FeedbackRequest:
      type: object
      properties:
        kind:
          type: string
          description: one of need_tool, need_data, bug, other
        message:
          type: string
          description: 10 to 1000 characters
        tool:
          type: string
          description: optional tool name
      required:
      - kind
      - message
    PostV1FeedbackResponse:
      type: object
      properties:
        ticket:
          type: string
          description: ticket id starting with fb_ and 32 hex characters
    GetV1FeedbackTicketResponse:
      type: object
      properties:
        status:
          type: string
          description: pending or answered
        reply:
          type: string
          description: automated assistant reply if answered
    PostV2ActsOpenkrillXTwitterScraperRunSyncGetDatasetItemsRequ:
      type: object
      properties:
        mode:
          type: string
        handles:
          type: array
          items:
            type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Acts
- name: Credits
- name: Docsort
- name: Feedback
- name: Jobs
- name: Library
- name: Mcp
- name: Mirror
- name: Oauth
- name: Tools
- name: Usage