Check a licence key

POST/licences/check

Costs 2 rate-limit points · Rate limits

Before adding keys: which of these keys already exist under any of these tags. Answers {duplicates: [key, ...]}; nothing is written.

Also searched ascheck for duplicate keysdo these keys already existvalidate keys before import

Request body

keysarray of stringsRequired
tagsarray of stringsRequired

Returns

duplicatesarray of strings

Errors

401

Missing or invalid API key.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

POST/licences/check

curl -X POST "https://app.filemonk.io/api/v2/external/licences/check" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keys": [
      "ABCD-EFGH-IJKL-0001",
      "ABCD-EFGH-0005"
    ],
    "tags": [
      "ebook-2026"
    ]
  }'

const res = await fetch("https://app.filemonk.io/api/v2/external/licences/check", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "keys": [
      "ABCD-EFGH-IJKL-0001",
      "ABCD-EFGH-0005"
    ],
    "tags": [
      "ebook-2026"
    ]
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.filemonk.io/api/v2/external/licences/check",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
    json={
        "keys": [
            "ABCD-EFGH-IJKL-0001",
            "ABCD-EFGH-0005"
        ],
        "tags": [
            "ebook-2026"
        ]
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/licences/check")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  keys: [
    "ABCD-EFGH-IJKL-0001",
    "ABCD-EFGH-0005"
  ],
  tags: [
    "ebook-2026"
  ]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "duplicates": [
    "ABCD-EFGH-0005"
  ]
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}