{"openapi":"3.1.0","info":{"title":"kuick agent API","version":"1.0.0","description":"Share text, files, links, polls and file requests as expiring links, and read them back. Keys are optional: a create without one returns an anonymous key (free plan). Account keys (kuick.io/account) act as the account, with its Plus features."},"servers":[{"url":"https://backend-api.kuick.io"}],"externalDocs":{"url":"https://kuick.io/agents"},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"kuick_… key"}}},"security":[{},{"apiKey":[]}],"paths":{"/v1/agent/shares":{"post":{"summary":"Make a sharing","description":"type is text (Markdown), file (returns an upload URL per file to PUT the bytes to), link, poll or file_request (Plus). expiresIn defaults to 24h.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"markdown":{"type":"string","minLength":1,"maxLength":500000},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"expiresIn":{"type":["number","string"]},"neverExpires":{"type":"boolean"},"oneTime":{"type":"boolean"},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]},"maxOpens":{"anyOf":[{"type":"integer","minimum":2,"maximum":100},{"type":"null"}]},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{1,46}[a-z0-9])$"},{"type":"null"}]},"recipients":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string"}},{"type":"null"}]},"notifyOnOpen":{"type":"boolean"},"useBoost":{"type":"boolean"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["type","markdown"]},{"type":"object","properties":{"type":{"type":"string","const":"file"},"files":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024},"size":{"type":"integer","minimum":0,"maximum":9007199254740991},"mimeType":{"type":"string","maxLength":255}},"required":["name","size"]}},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"expiresIn":{"type":["number","string"]},"neverExpires":{"type":"boolean"},"oneTime":{"type":"boolean"},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]},"maxOpens":{"anyOf":[{"type":"integer","minimum":2,"maximum":100},{"type":"null"}]},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{1,46}[a-z0-9])$"},{"type":"null"}]},"recipients":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string"}},{"type":"null"}]},"notifyOnOpen":{"type":"boolean"},"useBoost":{"type":"boolean"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["type","files"]},{"type":"object","properties":{"type":{"type":"string","const":"link"},"url":{"type":"string","maxLength":4096,"format":"uri"},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"expiresIn":{"type":["number","string"]},"neverExpires":{"type":"boolean"},"oneTime":{"type":"boolean"},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]},"maxOpens":{"anyOf":[{"type":"integer","minimum":2,"maximum":100},{"type":"null"}]},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{1,46}[a-z0-9])$"},{"type":"null"}]},"recipients":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string"}},{"type":"null"}]},"notifyOnOpen":{"type":"boolean"},"useBoost":{"type":"boolean"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","const":"poll"},"question":{"type":"string","minLength":1,"maxLength":300},"options":{"minItems":2,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"expiresIn":{"type":["number","string"]},"neverExpires":{"type":"boolean"},"oneTime":{"type":"boolean"},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]},"maxOpens":{"anyOf":[{"type":"integer","minimum":2,"maximum":100},{"type":"null"}]},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{1,46}[a-z0-9])$"},{"type":"null"}]},"recipients":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string"}},{"type":"null"}]},"notifyOnOpen":{"type":"boolean"},"useBoost":{"type":"boolean"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["type","question","options"]},{"type":"object","properties":{"type":{"type":"string","const":"file_request"},"message":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"expiresIn":{"type":["number","string"]},"neverExpires":{"type":"boolean"},"oneTime":{"type":"boolean"},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]},"maxOpens":{"anyOf":[{"type":"integer","minimum":2,"maximum":100},{"type":"null"}]},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{1,46}[a-z0-9])$"},{"type":"null"}]},"recipients":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string"}},{"type":"null"}]},"notifyOnOpen":{"type":"boolean"},"useBoost":{"type":"boolean"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["type"]}]}}}},"responses":{"200":{"description":"The link, and the upload URLs of a file sharing; `key` when the call came without one."},"402":{"description":"The settings need Plus or a Boost."}}},"get":{"summary":"List the key's live sharings","security":[{"apiKey":[]}],"responses":{"200":{"description":"Sharings"}}}},"/v1/agent/shares/{slug}":{"get":{"summary":"A sharing's activity","description":"Poll votes, file request submissions, opens. `wait` (seconds, up to 55) holds the answer until `total` passes `since`.","security":[{"apiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"The sharing's code (kuick.io/<code>)."},{"name":"wait","in":"query","schema":{"type":"integer","maximum":55}},{"name":"since","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Activity"}}},"delete":{"summary":"Delete a sharing","security":[{"apiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"The sharing's code (kuick.io/<code>)."}],"responses":{"200":{"description":"Deleted"}}}},"/v1/agent/read":{"post":{"summary":"Read any kuick link","description":"Opens a sharing held back by a passcode or a one-time open (which deletes it), and returns it with `markdown`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":4096},"passcode":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}]}},"required":["url"]}}}},"responses":{"200":{"description":"The sharing"},"403":{"description":"Wrong passcode"}}}},"/v1/contents/{slug}/export":{"get":{"summary":"A sharing as Markdown","description":"`format` md (default), json or txt. Doesn't open held-back sharings. Also at kuick.io/<code>.md.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"The sharing's code (kuick.io/<code>)."},{"name":"format","in":"query","schema":{"enum":["md","json","txt"]}}],"responses":{"200":{"description":"The sharing"}}}},"/v1/agent/keys":{"post":{"summary":"Get an anonymous key","responses":{"200":{"description":"The key, shown once"}}}},"/mcp":{"post":{"summary":"MCP server (Streamable HTTP, stateless)","responses":{"200":{"description":"JSON-RPC response"}}}}}}