Kaneme Documents API
The Documents API from Kaneme — 2 operation(s) for documents.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/kaneme-com:kaneme-com-documents-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. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Kaneme Documents API
version: 5.4.0
description: 'API REST de Kaneme : écrire dans ta voix, mesurer la fidélité d’un texte, attribuer sa paternité en probabilité calibrée, et gérer projets et documents. Les mêmes opérations, les mêmes bornes et les mêmes crédits que l’application. Deux axes distincts sont mesurés et jamais fusionnés : l’identité (mesurée) et la composition (déclarée, jamais détectée). Le TAMPON est calibré sur le français et sur l’anglais, chacun avec son propre moteur ; Q2 (toi ou un autre humain) rend une lecture indicative en français : sa probabilité est fournie, son libellé ne dépasse pas `Ambigu` ; en anglais, il ne conclut `signature` qu’au-dessus du seuil de son examen scellé, et dit `Ambigu` dessous. Sur un texte qui ne se lit ni en français ni en anglais, la vérification s’abstient et rend `probability: null` avec `unavailable: "unsupported_language"` ; quand la voix de référence n’est pas écrite dans la langue du texte, avec `"voice_language_mismatch"` ; quand une phrase entière, hors citation entre guillemets, est dans l’autre langue, avec `"mixed_language"` et les phrases dans `passages` — ce n’est PAS une panne, et le code se distingue de `embedding_layer` (couche indisponible) et `out_of_distribution` (registre non couvert). Une abstention n’est jamais facturée. Le RELEVÉ d’automatismes, lui, sort dans toutes les langues outillées : il compte ses marqueurs dans la langue qu’il a lue et rend `markerLanguage` pour dire lequel il a appliqué. Le champ `language` de chaque réponse porte la langue lue, `inDomain` dit si un verdict serait valide. L’API et le MCP sont ouverts à tout compte Kaneme, gratuit compris. Chaque opération se paie au crédit, exactement comme dans l’app : aucun second compteur. Le relevé d’automatismes (stylométrie locale) ne coûte rien ; un tampon coûte au plus 2 crédits, et rien quand le moteur s’abstient. Quand tes crédits disponibles sont épuisés, les opérations payantes s’arrêtent. Une recharge les réactive ; en espace personnel, la prochaine allocation mensuelle les réactive aussi. L’API renvoie HTTP 402 lorsque les crédits disponibles sont épuisés.'
servers:
- url: https://kaneme.com
security:
- apiKey: []
tags:
- name: Documents
paths:
/api/v1/documents:
get:
operationId: listDocuments
summary: Cherche et liste tes documents (titre, projet, canal)
tags:
- Documents
x-kaneme-credits: '0'
x-kaneme-credit-meter: voice
x-kaneme-required-scope: voice:read
x-kaneme-risk: read
x-kaneme-mcp-tool: list_documents
x-kaneme-timeout-seconds: 15
parameters:
- name: query
in: query
required: false
schema:
type: string
description: 'Cherche dans le TITRE (insensible à la casse). Le corps n’est pas indexé : chercher dedans rendrait des résultats inexplicables.'
- name: projectId
in: query
required: false
schema:
type: string
description: Restreint à un projet.
- name: format
in: query
required: false
schema:
type: string
enum:
- newsletter
- linkedin_post
- tweet_short
- thread
- tiktok_script
- instagram
- blog
- marketing_page
- academic_article
- email
- slack
- internal_note
- executive_communication
description: Restreint à un canal.
- name: limit
in: query
required: false
schema:
type: number
description: Taille de page (max 100).
- name: cursor
in: query
required: false
schema:
type: string
description: Curseur de pagination rendu par l’appel précédent. Un curseur illisible est une ERREUR, jamais un retour au début — sans quoi l’appelant boucle sur la première page en croyant avancer.
responses:
'200':
description: Succès.
headers:
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentList'
'400':
$ref: '#/components/responses/Invalide'
'401':
$ref: '#/components/responses/NonAutorise'
'402':
$ref: '#/components/responses/CreditsEpuises'
'404':
$ref: '#/components/responses/Introuvable'
'409':
$ref: '#/components/responses/Conflit'
'422':
$ref: '#/components/responses/NonMesurable'
'429':
$ref: '#/components/responses/TropDAppels'
'500':
$ref: '#/components/responses/ErreurServeur'
'503':
$ref: '#/components/responses/Indisponible'
post:
operationId: createDocument
summary: Crée un document (Markdown, voix, canal, provenance)
tags:
- Documents
x-kaneme-credits: '0'
x-kaneme-credit-meter: voice
x-kaneme-required-scope: voice:write
x-kaneme-risk: write
x-kaneme-mcp-tool: create_document
x-kaneme-timeout-seconds: 15
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
description: Rejouer le même appel avec la même clé rend le premier résultat sans re-débiter. Présent uniquement sur les opérations qui l’honorent réellement.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: Titre (max 300 caractères).
markdown:
type: string
description: Corps en Markdown (max 120 000 caractères).
projectId:
type: string
description: Projet de rattachement.
profileId:
type: string
description: Voix visée. Par défaut, la voix active du compte.
format:
type: string
enum:
- newsletter
- linkedin_post
- tweet_short
- thread
- tiktok_script
- instagram
- blog
- marketing_page
- academic_article
- email
- slack
- internal_note
- executive_communication
description: Canal visé.
provenance:
type: string
enum:
- human
- ai
description: Origine déclarée du texte.
additionalProperties: {}
required:
- title
example:
title: Post — leçons du projet client
markdown: '## Ce que j’ai appris
Trois choses, dans l’ordre où elles m’ont coûté cher.'
format: linkedin_post
provenance: human
responses:
'200':
description: Succès.
headers:
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreated'
'400':
$ref: '#/components/responses/Invalide'
'401':
$ref: '#/components/responses/NonAutorise'
'402':
$ref: '#/components/responses/CreditsEpuises'
'404':
$ref: '#/components/responses/Introuvable'
'409':
$ref: '#/components/responses/Conflit'
'422':
$ref: '#/components/responses/NonMesurable'
'429':
$ref: '#/components/responses/TropDAppels'
'500':
$ref: '#/components/responses/ErreurServeur'
'503':
$ref: '#/components/responses/Indisponible'
/api/v1/documents/{id}:
get:
operationId: getDocument
summary: Lit un document (texte + HTML)
tags:
- Documents
x-kaneme-credits: '0'
x-kaneme-credit-meter: voice
x-kaneme-required-scope: voice:read
x-kaneme-risk: read
x-kaneme-mcp-tool: get_document
x-kaneme-timeout-seconds: 15
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Identifiant de la ressource.
responses:
'200':
description: Succès.
headers:
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
'400':
$ref: '#/components/responses/Invalide'
'401':
$ref: '#/components/responses/NonAutorise'
'402':
$ref: '#/components/responses/CreditsEpuises'
'404':
$ref: '#/components/responses/Introuvable'
'409':
$ref: '#/components/responses/Conflit'
'422':
$ref: '#/components/responses/NonMesurable'
'429':
$ref: '#/components/responses/TropDAppels'
'500':
$ref: '#/components/responses/ErreurServeur'
'503':
$ref: '#/components/responses/Indisponible'
patch:
operationId: updateDocument
summary: Corrige un document existant plutôt que d’en créer un second
tags:
- Documents
x-kaneme-credits: '0'
x-kaneme-credit-meter: voice
x-kaneme-required-scope: voice:write
x-kaneme-risk: write
x-kaneme-mcp-tool: update_document
x-kaneme-timeout-seconds: 15
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Identifiant de la ressource.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: Nouveau titre.
markdown:
type: string
description: Nouveau corps — remplace TOUT le document.
replace:
type: object
properties:
find:
type: string
replaceWith:
type: string
all:
type: boolean
required:
- find
- replaceWith
additionalProperties: {}
description: 'Retouche ciblée : { find, replaceWith, all? }. « find » est cherché à l’identique dans le contenu stocké ; introuvable ou ambigu = refus, jamais une correction au hasard. Exclusif avec « markdown ».'
projectId:
anyOf:
- type: string
- type: 'null'
description: Nouveau projet (null pour détacher).
profileId:
anyOf:
- type: string
- type: 'null'
description: Nouvelle voix (null pour détacher).
format:
anyOf:
- type: string
enum:
- newsletter
- linkedin_post
- tweet_short
- thread
- tiktok_script
- instagram
- blog
- marketing_page
- academic_article
- email
- slack
- internal_note
- executive_communication
- type: 'null'
description: Nouveau canal.
provenance:
type: string
enum:
- human
- ai
description: Nouvelle provenance.
additionalProperties: {}
example:
markdown: '## Ce que j’ai appris
Quatre choses, finalement.'
responses:
'200':
description: Succès.
headers:
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdated'
'400':
$ref: '#/components/responses/Invalide'
'401':
$ref: '#/components/responses/NonAutorise'
'402':
$ref: '#/components/responses/CreditsEpuises'
'404':
$ref: '#/components/responses/Introuvable'
'409':
$ref: '#/components/responses/Conflit'
'422':
$ref: '#/components/responses/NonMesurable'
'429':
$ref: '#/components/responses/TropDAppels'
'500':
$ref: '#/components/responses/ErreurServeur'
'503':
$ref: '#/components/responses/Indisponible'
delete:
operationId: deleteDocument
summary: Met le document à la corbeille (restaurable 30 jours)
tags:
- Documents
x-kaneme-credits: '0'
x-kaneme-credit-meter: voice
x-kaneme-required-scope: voice:manage
x-kaneme-risk: manage
x-kaneme-mcp-tool: delete_document
x-kaneme-timeout-seconds: 15
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Identifiant de la ressource.
responses:
'200':
description: Succès.
headers:
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentDeleted'
'400':
$ref: '#/components/responses/Invalide'
'401':
$ref: '#/components/responses/NonAutorise'
'402':
$ref: '#/components/responses/CreditsEpuises'
'404':
$ref: '#/components/responses/Introuvable'
'409':
$ref: '#/components/responses/Conflit'
'422':
$ref: '#/components/responses/NonMesurable'
'429':
$ref: '#/components/responses/TropDAppels'
'500':
$ref: '#/components/responses/ErreurServeur'
'503':
$ref: '#/components/responses/Indisponible'
components:
schemas:
DocumentUpdated:
type: object
properties:
id:
type: string
title:
type: string
format:
anyOf:
- type: string
- type: 'null'
workspaceId:
type: string
projectId:
anyOf:
- type: string
- type: 'null'
profileId:
anyOf:
- type: string
- type: 'null'
provenance:
anyOf:
- type: string
- type: 'null'
updatedAt:
type: string
text:
type: string
html:
type: string
required:
- id
- title
- format
- workspaceId
- projectId
- profileId
- provenance
- updatedAt
- text
- html
additionalProperties: {}
DocumentDeleted:
type: object
properties:
id:
type: string
trashed:
type: boolean
const: true
restorableDays:
type: number
required:
- id
- trashed
- restorableDays
additionalProperties: {}
DocumentList:
type: object
properties:
documents:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
updatedAt:
type: string
projectId:
anyOf:
- type: string
- type: 'null'
profileId:
anyOf:
- type: string
- type: 'null'
format:
anyOf:
- type: string
- type: 'null'
provenance:
anyOf:
- type: string
- type: 'null'
required:
- id
- title
- updatedAt
- projectId
- profileId
- format
- provenance
additionalProperties: {}
nextCursor:
anyOf:
- type: string
- type: 'null'
required:
- documents
- nextCursor
additionalProperties: {}
Document:
type: object
properties:
id:
type: string
title:
type: string
format:
anyOf:
- type: string
- type: 'null'
workspaceId:
type: string
projectId:
anyOf:
- type: string
- type: 'null'
profileId:
anyOf:
- type: string
- type: 'null'
provenance:
anyOf:
- type: string
- type: 'null'
updatedAt:
type: string
text:
type: string
html:
type: string
required:
- id
- title
- format
- workspaceId
- projectId
- profileId
- provenance
- updatedAt
- text
- html
additionalProperties: {}
DocumentCreated:
type: object
properties:
id:
type: string
title:
type: string
url:
type: string
projectId:
anyOf:
- type: string
- type: 'null'
profileId:
anyOf:
- type: string
- type: 'null'
format:
anyOf:
- type: string
enum:
- newsletter
- linkedin_post
- tweet_short
- thread
- tiktok_script
- instagram
- blog
- marketing_page
- academic_article
- email
- slack
- internal_note
- executive_communication
- type: 'null'
provenance:
anyOf:
- type: string
enum:
- human
- ai
- type: 'null'
required:
- id
- title
- url
- projectId
- profileId
- format
- provenance
additionalProperties: {}
responses:
Indisponible:
description: Service ou compteur temporairement indisponible.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
NonMesurable:
description: Le moteur s’abstient ou le corpus est insuffisant.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
ErreurServeur:
description: Erreur interne.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
NonAutorise:
description: Clé absente, invalide ou révoquée.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
TropDAppels:
description: 'Cadence dépassée (code « rate_limited »). La réponse porte X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Window et Retry-After — attends la fenêtre indiquée : un retry immédiat la prolonge. Les plafonds appliqués sont dans x-kaneme-rate-limits. Quand le refus vient d’un plafond PAR OPÉRATION (générer, créer un document ou un projet, déposer une source), ces nombres sont ceux de CETTE opération, pas ceux de la surface.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
headers:
Retry-After:
schema:
type: integer
description: Secondes à attendre. Ne part que sur un refus.
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateRemaining'
X-RateLimit-Window:
$ref: '#/components/headers/RateWindow'
CreditsEpuises:
description: 'Crédits insuffisants, OU surface non ouverte à ce compte. code = "subscription_required" : L’API et le MCP se paient en crédits, et ce compte n’en a plus. Recharge ton solde pour réactiver ta clé. code = "credits_exhausted" : lire `window` pour savoir quoi faire (recharger, attendre la période, demander à un admin de relever le budget, relever le plafond de la clé).'
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
window:
type: string
enum:
- balance
- period
- budget
- api_key
description: 'Présent quand code = "credits_exhausted". `balance` : solde vide, la suite est une recharge. `period` : ancien abonnement, le quota repart à la période suivante. `budget` : membre d’une équipe dont le budget mensuel est pris — un admin le relève ; recharger n’y change rien. `api_key` : la clé appelante a pris son plafond mensuel (réglé par son propriétaire dans Connexions) ; l’app et les autres clés continuent. `budget` et `api_key` repartent le 1er du mois (UTC).'
meter:
type: string
description: Compteur concerné (« voice »).
budget:
type: object
description: 'Pour `window` = `budget` ou `api_key` : le plafond du mois et ce qui est déjà pris, en crédits.'
properties:
limit:
type: integer
used:
type: integer
required:
- limit
- used
required:
- error
Conflit:
description: Conflit d’état ou de clé d’idempotence.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
Introuvable:
description: Ressource introuvable.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
Invalide:
description: Requête invalide (champ manquant, borne dépassée, curseur illisible).
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Compatibility alias for the localized message.
message:
type: string
description: Message in the verified account interface_locale; French when no account preference is available.
code:
type: string
description: Stable machine code, independent of message language (for example, invalid_input).
required:
- code
- message
headers:
RateWindow:
schema:
type: integer
description: Durée de la fenêtre, en secondes.
RequestId:
schema:
type: string
format: uuid
description: 'Identifiant de CETTE réponse. Journalise-le : c’est ce qu’on te demandera pour retrouver ton appel, et il est écrit dans nos traces sur les erreurs internes.'
RateLimit:
schema:
type: integer
description: Appels autorisés par fenêtre, pour le plafond qui s’applique à cet appel.
RateRemaining:
schema:
type: integer
description: Appels restants dans la fenêtre, au passage de la garde — le jeton de cette requête est déjà décompté.
securitySchemes:
apiKey:
type: http
scheme: bearer
description: 'Clé d’API du compte, créée sur la page Connexions. En-tête : `Authorization: Bearer kaneme_…`. Les clés `frq_…` émises avant le changement de nom restent acceptées. C’est la voie MACHINE-À-MACHINE : un programme qui agit pour son propre compte. Ses portées sont choisies à la création ; les gestes sensibles restent décochés par défaut. Les clés historiques sans portées explicites conservent leur accès pour compatibilité. Pour qu’un agent agisse au nom d’un utilisateur, passer par le serveur MCP (`/api/mcp`), dont Kaneme émet les jetons OAuth.'
x-kaneme-contract-version: 5.4.0
x-kaneme-rate-limits:
- scope: Toute la surface
countedBy: par clé (ou par client OAuth)
limit: 60
windowSeconds: 60
detail: Compté sur l’ensemble des appels /api/v1 et /api/mcp du même porteur.
- scope: Générer un texte
countedBy: par compte
limit: 10
windowSeconds: 10
detail: 'Fenêtre PARTAGÉE avec l’éditeur de l’app : la clé ne contourne pas la cadence.'
- scope: Créer un document
countedBy: par compte
limit: 10
windowSeconds: 10
detail: Gratuit en crédits — la cadence est sa seule borne.
- scope: Créer un projet
countedBy: par compte
limit: 10
windowSeconds: 10
detail: Gratuit en crédits — la cadence est sa seule borne.
- scope: Archiver, mettre à la corbeille ou restaurer
countedBy: par clé (ou client OAuth)
limit: 10
windowSeconds: 60
detail: Lots de 10 maximum, prévisualisables avec dryRun. Aucune purge définitive par API/MCP.
- scope: Vérifier un certificat (sans clé)
countedBy: par adresse IP
limit: 60
windowSeconds: 60
detail: 'Ouverte sans compte : le plafond se compte sur l’appelant lui-même, pas sur un porteur.'
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/kaneme-com/openapi/kaneme-com-documents-api-openapi.yml