Referência da API REST

Todos os endpoints da API REST do CortexPlus, gerados a partir da especificação OpenAPI publicada. As descrições dos campos vêm direto da spec, em inglês.

Referência interativa (Redoc) openapi.json Voltar ao guia

URL base e autenticação

Todos os endpoints ficam em https://api.cortexplus.io e recebem e devolvem JSON. Os corpos são limitados a 1 MB, exceto uploads de áudio e imagem.

Envie a sua chave como Authorization: Bearer cortex_.... Crie uma em Chaves de API. Os endpoints marcados como sem autenticação servem para criar conta ou entrar.

Requisição autenticada

curl -sS https://api.cortexplus.io/v1/auth/me \
  -H 'authorization: Bearer cortex_...'

Uploads, limites por arquivo e deduplicação

Confira os hashes conhecidos antes de enviar; depois, crie um upload assinado e salve o arquivo enviado como memória.

POST /v1/uploads/known aceita de 1 a 500 hashes SHA-256 em hexadecimal minúsculo, compatíveis com ^[0-9a-f]{64}$. Retorna { "known": [{ "sha256", "nodeId" }] }; hashes que já estão na conta não precisam ser enviados novamente.

POST /v1/uploads aceita { "name", "contentType", "size" }. O campo opcional size é o tamanho exato do arquivo em bytes. A resposta inclui key, uploadUrl e expiresIn para o PUT assinado.

Se o tamanho informado exceder o limite do plano, a solicitação é rejeitada antes da assinatura com HTTP 413 e { "error": "upload_too_large", "resource": "uploadMaxBytes", "requested", "limit" }. Ao enviar size, o PUT precisa usar exatamente esse Content-Length.

O limite por arquivo é de 500 MB no Free e 10 GB nos planos pagos.

POST /v1/memories aceita { "key", "sha256", "contentType", "name", "tags" }. O campo opcional sha256 usa hexadecimal minúsculo e permite que o CortexPlus deduplique fotos e vídeos repetidos por usuário. A resposta contém "duplicate": true quando o conteúdo já existia, sem contar nada duas vezes.

GET /v1/usage retorna os limites do plano, incluindo quotas.uploadMaxBytes.

1. Confira se o hash do arquivo já é conhecido

curl -sS https://api.cortexplus.io/v1/uploads/known \
  -H 'authorization: Bearer $CORTEX_API_KEY' \
  -H 'content-type: application/json' \
  -d '{"hashes":["'"$SHA256"'"]}'

2. Crie um upload e envie o arquivo

upload=$(curl -sS https://api.cortexplus.io/v1/uploads \
  -H 'authorization: Bearer $CORTEX_API_KEY' \
  -H 'content-type: application/json' \
  -d "{\"name\":\"$FILE_NAME\",\"contentType\":\"$CONTENT_TYPE\",\"size\":$SIZE}")
KEY=$(printf '%s' "$upload" | jq -r '.key')
url=$(printf '%s' "$upload" | jq -r '.uploadUrl')
curl -sS -X PUT "$url" -H "Content-Type: $CONTENT_TYPE" --upload-file "$FILE"

3. Crie a memória com o SHA-256

curl -sS https://api.cortexplus.io/v1/memories \
  -H 'authorization: Bearer $CORTEX_API_KEY' \
  -H 'content-type: application/json' \
  -d "{\"key\":\"$KEY\",\"sha256\":\"$SHA256\",\"contentType\":\"$CONTENT_TYPE\",\"name\":\"$FILE_NAME\",\"tags\":[]}"

Conta e login

POST /v1/signup Sem autenticação

Create a CortexPlus account.

Create an account or begin signing in. CortexPlus sends a 6-digit code by email; use the connect operation with that code and the email next.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)	Email address for the CortexPlus account.
name	string
client	string	Name of the AI platform requesting the connection.

Respostas

202 Successful response.

Nome	Tipo	Descrição
sent *	boolean

POST /v1/connect Sem autenticação

Connect a CortexPlus account.

Redeem the 6-digit code received by email. Save the returned apiKey in the connector configuration.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)	Email the code was sent to.
key *	string	6-digit code received by email.
client	string	Name of the AI platform requesting the connection.

Respostas

200 Successful response.

Nome	Tipo	Descrição
apiKey *	string
email *	string
name *	string

POST /v1/auth/register Sem autenticação

Register an account.

Create a CortexPlus account. A 6-digit code is emailed and the account stays pending (202) until it is confirmed with /v1/auth/verify. When verification is disabled the response is a device session (201).

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)
name	string
password *	string	8–∞ chars
deviceName	string
platform	string

Respostas

201 Successful response.

Nome	Tipo	Descrição
deviceToken *	string	Device credential (cxd_…); use it as the bearer token.
user *	object

202 Successful response.

Nome	Tipo	Descrição
verificationRequired *	true
email *	string

POST /v1/auth/login Sem autenticação

Log in and start a device session.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)
password *	string
deviceName	string
platform	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
deviceToken *	string	Device credential (cxd_…); use it as the bearer token.
user *	object

403 Request failed.

Nome	Tipo	Descrição
error *	string
field	string

POST /v1/auth/verify Sem autenticação

Confirm the signup email and start a device session.

Confirm the email with the 6-digit code sent at signup and issue a device token for this app install.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)
code *	string	6-digit code received by email.
deviceName	string
platform	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
deviceToken *	string	Device credential (cxd_…); use it as the bearer token.
user *	object

POST /v1/auth/verify/resend Sem autenticação

Send a new signup verification code.

Email a new verification code to a pending account. Requires the signup password.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)
password *	string	Password chosen at signup.

Respostas

202 Successful response.

Nome	Tipo	Descrição
sent *	boolean

POST /v1/auth/key Sem autenticação

Request an email sign-in code.

Send a 6-digit sign-in code to the account email address.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)

Respostas

202 Successful response.

Nome	Tipo	Descrição
sent *	boolean
expiresInMinutes *	integer

POST /v1/auth/key/redeem Sem autenticação

Redeem an email sign-in code.

Redeem the 6-digit code received by email (with the same email) and issue a device token for this app install.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string (email)	Email the code was sent to.
key *	string	6-digit code received by email.
deviceName	string
platform	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
deviceToken *	string	Device credential (cxd_…); use it as the bearer token.
user *	object

GET /v1/auth/me Chave Bearer

Get the current account.

Return the account behind the presented credential.

Respostas

200 Successful response.

PATCH /v1/auth/me Chave Bearer

Update the current account profile.

Update the account display name and/or language, timezone, geolocation and health agent access settings.

Corpo da requisição application/json

Nome	Tipo	Descrição
name	string	1–100 chars
settings	object
settings.language	"pt-BR" \| "en" \| "es"
settings.timezone	string	1–∞ chars
settings.geolocation	boolean	Record location sent with memory captures. · default true
settings.healthAgentAccess	boolean	Share health (`saude`) memories with AI assistants using API keys (MCP and integrations). · default false
settings.birthDate	string \| null (date)	Birth date used for nutrition intake ranges; `null` clears it.
settings.sex	"male" \| "female" \| null	Biological sex used for nutrition intake ranges; `null` clears it.
settings.activityLevel	"sedentary" \| "light" \| "moderate" \| "active" \| null	Physical activity level used for the estimated energy requirement.

Respostas

200 Successful response.

DELETE /v1/auth/me Chave Bearer

Delete the current account.

Permanently delete the account and all associated data.

Corpo da requisição application/json

Nome	Tipo	Descrição
email *	string

Respostas

204 Account deleted.

POST /v1/auth/password Chave Bearer

Set or change the account password.

Set a password on a passwordless account, or change it when currentPassword is provided. Other device tokens are revoked.

Corpo da requisição application/json

Nome	Tipo	Descrição
newPassword *	string	8–∞ chars
currentPassword	string	Required when the account already has a password.

Respostas

204 Password updated.

GET /v1/auth/devices Chave Bearer

List devices.

List the account’s active device tokens.

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
currentDeviceId *	string \| null	Id of the calling device when authenticated with a device token.

DELETE /v1/auth/devices/{id} Chave Bearer

Revoke a device.

Revoke a device token. Use the id current to revoke the device making this call (sign out).

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Device id, or the literal current.

Respostas

204 Device revoked.

Memórias

POST /v1/search Chave Bearer

Search memory.

Search the user’s CortexPlus memory.

Corpo da requisição application/json

Nome	Tipo	Descrição
query *	string	Text to search for in memory.
limit	integer	1–50, default 10

Respostas

200 Successful response.

Nome	Tipo	Descrição
results *	object[]
results[].id *	string
results[].title *	string
results[].url *	string (uri)
results[].text	string

POST /v1/recall Chave Bearer

Recall context.

Build context from the user’s CortexPlus memory.

Corpo da requisição application/json

Nome	Tipo	Descrição
query *	string	Question to answer from memory.
limit	integer	1–50, default 10
depth	integer	0–3, default 1
maxChars	integer	500–20000, default 6000

Respostas

200 Successful response.

Nome	Tipo	Descrição
text *	string
matches *	integer

GET /v1/memories/{id} Chave Bearer

Get a memory.

Retrieve one CortexPlus memory by id. With view=node the full node is returned, as the app routes return it.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.
view	"node" · query

Respostas

200 Successful response.

PATCH /v1/memories/{id} Chave Bearer

Update a memory.

Update a memory and return the full node.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
title	string
content	string
type	string
tags	string[]
attributes	object
parentId	string \| null	Parent memory id; null detaches the memory. Cycles are rejected.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

DELETE /v1/memories/{id} Chave Bearer

Delete a memory.

Delete one CortexPlus memory by id.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

204 Memory deleted.

GET /v1/memories/{id}/ancestors Chave Bearer

List parent memories.

Return the chain of parent memories, from the root down to the direct parent.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
limit	integer
offset	integer
removed	string[]
nextCursor	string \| null
syncToken	string \| null
reset	boolean

GET /v1/memories/{id}/descendants Chave Bearer

List nested memories.

Return every memory nested under this one, breadth-first. Each item has depth (1 = direct child).

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.
maxDepth	integer · query	≥ 1
limit	integer · query	1–2000, default 500

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
truncated *	boolean

PUT /v1/memories/{id}/horizon Chave Bearer

Set the memory horizon.

Set how the memory is highlighted or expires. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
kind *	"persistent" \| "recurring" \| "dated" \| "short"	persistent: highlighted every day; recurring: highlighted every interval; dated: highlighted from date on; short: archived after days.
interval	"daily" \| "weekly" \| "biweekly"	Required when kind is recurring.
date	string (date)	Required when kind is dated (YYYY-MM-DD).
days	integer	Short-term lifetime; defaults to 7. · 1–365
notify	boolean	Send an own reminder (not for short). Without time it fires at 09:00 in the user timezone.
time	string	Reminder time (HH:MM) in the user timezone.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

DELETE /v1/memories/{id}/horizon Chave Bearer

Remove the memory horizon.

Stop highlighting the memory. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

POST /v1/memories/{id}/ack Chave Bearer

Mark a highlight as handled today.

Hide the memory from highlights until its next occurrence. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

POST /v1/memories/{id}/complete Chave Bearer

Complete a memory.

Mark the memory as done and archive it. With `cascade: true`, every open subtask (descendant of type task) is completed too. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
cascade	boolean

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

POST /v1/memories/{id}/reopen Chave Bearer

Reopen a memory.

Undo completion and bring the memory back from the archive. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

POST /v1/memories/{id}/archive Chave Bearer

Archive a memory.

Hide the memory from default listings and highlights. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

POST /v1/memories/{id}/unarchive Chave Bearer

Unarchive a memory.

Bring an archived memory back to default listings. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ancestors	object[]
ancestors[].id *	string
ancestors[].title *	string
ancestors[].type *	string
ancestors[].tags *	string[]
interaction	object
interaction.lastAt *	string \| null (date-time)
interaction.days *	integer \| null
interaction.answered *	boolean
parent	object
parent.id *	string
parent.title *	string
parent.type *	string
parent.tags *	string[]
relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
relevance.score	integer	0–100
relevance.level	"low" \| "normal" \| "high" \| "critical"
relevance.reasons	string[]
relevance.snoozedUntil	string \| null (date)
relevance.aiDelta	integer	-20–20

GET /v1/memories/{id}/comments Chave Bearer

List memory comments.

Return the dated comments of a memory, newest first.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.
limit	integer · query	1–200, default 200
before	string (date-time) · query	Only comments created before this ISO time (pagination cursor).

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].id *	string
items[].nodeId *	string
items[].body *	string
items[].createdAt *	string (date-time)
items[].updatedAt	string (date-time)

POST /v1/memories/{id}/comments Chave Bearer

Comment on a memory.

Add a dated comment; it also marks the highlight as handled today. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
body *	string	1–5000 chars

Respostas

201 Successful response.

Nome	Tipo	Descrição
id *	string
nodeId *	string
body *	string
createdAt *	string (date-time)
updatedAt	string (date-time)

GET /v1/memories/{id}/attachment Chave Bearer

Get a download URL for a memory's attachment.

Return a short-lived download URL for the memory attachment. The URL expires after expiresIn seconds. Returns 404 when the memory has no stored attachment.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.
variant	"thumb" \| "original" · query	Return a thumbnail URL when available, otherwise the original attachment URL. · default "original"

Respostas

200 Successful response.

Nome	Tipo	Descrição
url *	string (uri)
expiresIn *	number

DELETE /v1/memories/{id}/photo Chave Bearer

Delete a memory photo.

Remove the attachment from the memory and delete its stored photo. Meals and notes are preserved. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Respostas

200 Successful response.

POST /v1/memories/{id}/nutrition/retry Chave Bearer

Recalculate a meal's nutrient estimate.

Re-run the nutrition estimate for a meal memory with an optional replacement description, and return the updated node. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
description	string	0–2000 chars

Respostas

200 Successful response.

Nome	Tipo	Descrição
node *	object	Full node as returned by the CortexPlus backend.
node.ancestors	object[]
node.interaction	object
node.parent	object
node.relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

POST /v1/memories/{id}/repeat Chave Bearer

Register a meal again today.

Copy a ready meal to today without its attachment. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Nome	Tipo	Descrição
clientId	string	0–200 chars

Respostas

200 Successful response.

Nome	Tipo	Descrição
node *	object	Full node as returned by the CortexPlus backend.
node.ancestors	object[]
node.interaction	object
node.parent	object
node.relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
duplicate *	boolean

POST /v1/memories/{id}/nutrition/adjust Chave Bearer

Adjust a meal's nutrient estimate.

Recalculate a meal memory using a nutrition-label photo or a named product, and return the updated node. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Memory id.

Corpo da requisição application/json

Respostas

200 Successful response.

Nome	Tipo	Descrição
node *	object	Full node as returned by the CortexPlus backend.
node.ancestors	object[]
node.interaction	object
node.parent	object
node.relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

POST /v1/remember Chave Bearer

Remember a note.

Store a note in the user’s CortexPlus memory.

Corpo da requisição application/json

Nome	Tipo	Descrição
content *	string	Note content to store.
title	string
tags	string[]
type	string	default "note"
attributes	object	Additional node attributes.
parentId	string	Id of an existing memory to nest this note under.

Respostas

201 Successful response.

Nome	Tipo	Descrição
id *	string
title	string

POST /v1/uploads Chave Bearer

Create an audio, photo, or video upload.

Create a signed upload URL for an audio, photo, or video memory.

Corpo da requisição application/json

Nome	Tipo	Descrição
name *	string	Name of the audio file.
contentType *	string	MIME type of the audio file.
size	integer	Exact file size in bytes. When sent, oversized files are rejected before signing and the PUT must send this exact Content-Length. · ≥ 1
expiresIn	integer	Presigned URL lifetime in seconds. · 60–86400

Respostas

200 Successful response.

Nome	Tipo	Descrição
key *	string
uploadUrl *	string (uri)
expiresIn *	integer

GET /v1/memories Chave Bearer

List memories.

List the account’s memories ordered by last update, or search them semantically with q. Supply changedSince to fetch memory changes since a sync token. Returns full nodes.

Parâmetros

Nome	Tipo	Descrição
limit	integer · query	1–100, default 30
offset	integer · query	Nonzero offsets cannot be combined with changedSince. · ≥ 0, default 0
changedSince	string · query	Sync token from an earlier memories list or delta response; cannot be combined with q. · 1–∞ chars
cursor	string · query	Delta pagination cursor; only valid with changedSince. · 1–∞ chars
type	string · query
tag	string[] · query	Repeatable tag filter.
client	string · query
excludePhotos	boolean · query	Hide image and video notes from generic memory lists.
q	string · query	Semantic search query.
mode	"semantic" \| "text" · query	default "semantic"
parentId	string · query	Only direct children of this memory id; `root` returns only memories without a parent.
archived	"false" \| "true" \| "all" · query	Archived memories (completed tasks, expired short-term memories) are hidden by default; `true` lists only them and `all` lists both. Ignored when q is set. · default "false"

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
limit	integer
offset	integer
removed	string[]
nextCursor	string \| null
syncToken	string \| null
reset	boolean

POST /v1/memories Chave Bearer

Save a memory.

Classify and save text from a note, task, or reminder, or ingest photos and videos by storage key. Binary audio is sent to storage and transcribed asynchronously; binary images are described and OCRed asynchronously.

Parâmetros

Nome	Tipo	Descrição
Idempotency-Key	string · header	Client-generated idempotency key; overrides clientId in the request body or query. · 8–100 chars
clientId	string · query	Client id fallback for JSON or binary captures; body clientId takes precedence for JSON, and Idempotency-Key takes precedence over both. · 8–100 chars
capturedAt	string (date-time) · query	ISO capture time fallback for JSON or binary captures; body capturedAt takes precedence for JSON.
capturedAtSource	"clock" \| "exif" \| "takeout" \| "file" \| "user" · query	Capture date source for JSON or binary captures; body capturedAtSource takes precedence for JSON.
auto	"0" \| "1" \| "true" \| "false" · query	Binary uploads: set to 1 to classify by content (meal, task, reminder, note) instead of mode.
lat	number · query	Capture latitude for binary uploads; requires lon. · -90–90
lon	number · query	Capture longitude for binary uploads; requires lat. · -180–180
accuracy	number · query	Optional capture accuracy in meters for binary uploads. · ≥ 0

Corpo da requisição application/json, audio/, image/

Opção 1

Nome	Tipo	Descrição
text *	string	Text to classify and save.
tags	string[]
via	string
location	object	Capture coordinates recorded in attributes.location. The backend discards the value when the account geolocation setting is off.
location.lat *	number	-90–90
location.lon *	number	-180–180
location.accuracy	number	≥ 0
location.capturedAt	string (date-time)
clientId	string	8–100 chars
capturedAt	string (date-time)
capturedAtSource	"clock" \| "exif" \| "takeout" \| "file" \| "user"
auto	boolean	Classify by content instead of mode: detects meals, tasks, reminders and notes and may create several linked memories.

Opção 2

Nome	Tipo	Descrição
key *	string	R2 object key from createUpload.
sha256	string	Optional lowercase hex SHA-256 of the uploaded file; lets CortexPlus deduplicate repeated photos/videos per user.
durationSeconds	number	≥ 0
contentType	string	audio/, image/ or video/* MIME type; video is ingested only by key, never as a binary body.
note	string	Optional text explaining what a photo contains (used by the meal estimate). · 0–2000 chars
noteAudioKey	string	Optional R2 key of an audio (from createUpload) explaining the photo; it is transcribed and used with note.
noteAudioSeconds	number	Duration of the noteAudioKey audio. · ≥ 0
name	string
tags	string[]
via	string
location	object	Capture coordinates recorded in attributes.location. The backend discards the value when the account geolocation setting is off.
location.lat *	number	-90–90
location.lon *	number	-180–180
location.accuracy	number	≥ 0
location.capturedAt	string (date-time)
clientId	string	8–100 chars
capturedAt	string (date-time)
capturedAtSource	"clock" \| "exif" \| "takeout" \| "file" \| "user"
auto	boolean	Classify by content instead of mode: detects meals, tasks, reminders and notes and may create several linked memories.

Opção 3

Nome	Tipo	Descrição
audioBase64 *	string	Base64-encoded audio file, up to 25 MB after decoding.
contentType	string	Audio MIME type.
name	string
durationSeconds	number	≥ 0
tags	string[]
via	string
location	object	Capture coordinates recorded in attributes.location. The backend discards the value when the account geolocation setting is off.
location.lat *	number	-90–90
location.lon *	number	-180–180
location.accuracy	number	≥ 0
location.capturedAt	string (date-time)
clientId	string	8–100 chars
capturedAt	string (date-time)
capturedAtSource	"clock" \| "exif" \| "takeout" \| "file" \| "user"
auto	boolean	Classify by content instead of mode: detects meals, tasks, reminders and notes and may create several linked memories.

Respostas

201 Successful response.

Nome	Tipo	Descrição
id *	string
clientId *	string \| null
duplicate *	boolean
type *	string
title *	string
client *	string \| null
status *	string \| null
memory *	string \| null
review *	string \| null
resolved *	boolean \| null
url *	string (uri)

GET /v1/tasks Chave Bearer

List tasks.

List open tasks and reminders from CortexPlus.

Parâmetros

Nome	Tipo	Descrição
status	string · query	Task status to filter by. · default "open"
client	string · query	Client name or slug to filter by.
limit	integer · query	Maximum number of tasks to return. · 1–50, default 20

Respostas

200 Successful response.

Nome	Tipo	Descrição
tasks *	object[]
tasks[].id *	string
tasks[].title *	string
tasks[].client *	string \| null
tasks[].status *	string \| null
tasks[].dueAt *	string \| null
tasks[].url *	string (uri)

Chaves de API e uso

GET /v1/apikeys Chave Bearer

List API keys.

List the account’s API keys.

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]

POST /v1/apikeys Chave Bearer

Create an API key.

Create an API key. The plaintext key is returned only in this response.

Corpo da requisição application/json

Nome	Tipo	Descrição
label *	string

Respostas

201 Successful response.

DELETE /v1/apikeys/{id} Chave Bearer

Revoke an API key.

Revoke one API key by id.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	API key id.

Respostas

204 API key revoked.

GET /v1/usage Chave Bearer

Get usage summary.

Return the account’s usage counters and plan quotas.

Respostas

200 Successful response.

Outros endpoints

GET /v1/highlights Chave Bearer

List today's highlighted memories.

Return the memories that should be highlighted today in the user timezone (persistent, due recurring and dated memories not yet handled today), with highlight occurrence, a comment summary and a subtask summary (`subtasks: { total, done }`).

Parâmetros

Nome	Tipo	Descrição
limit	integer · query	1–200

Respostas

200 Successful response.

Nome	Tipo	Descrição
day *	string (date)
timezone *	string
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

GET /v1/notifications Chave Bearer

List inbox notifications.

Return the notification inbox, newest first. Page with before=nextCursor.

Parâmetros

Nome	Tipo	Descrição
limit	integer · query	1–100
before	string (date-time) · query
unread	"true" \| "false" · query

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].id *	string
items[].type *	string	e.g. memory.highlights.daily, memory.task.due, finance.bill.due.
items[].category *	"memory" \| "finance" \| "capture" \| "account"
items[].title *	string
items[].body *	string
items[].data *	object	Deep-link hints: screen (memory, highlights, finance, usage) and id.
items[].nodeId *	string \| null
items[].createdAt *	string (date-time)
items[].readAt *	string \| null (date-time)
nextCursor *	string \| null
unread *	integer

GET /v1/notifications/unread Chave Bearer

Count unread notifications.

Respostas

200 Successful response.

Nome	Tipo	Descrição
unread *	integer

POST /v1/notifications/read Chave Bearer

Mark notifications as read.

Mark notifications as read. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
ids *	string[]

Respostas

200 Successful response.

Nome	Tipo	Descrição
ids *	string[]
unread *	integer

POST /v1/notifications/read-all Chave Bearer

Mark every notification as read.

Mark every notification as read. Requires the cortex.write scope.

Respostas

200 Successful response.

Nome	Tipo	Descrição
ids *	string[]
unread *	integer

POST /v1/notifications/archive Chave Bearer

Remove notifications from the inbox.

Remove notifications from the inbox. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
ids *	string[]

Respostas

200 Successful response.

Nome	Tipo	Descrição
ids *	string[]
unread *	integer

GET /v1/notifications/preferences Chave Bearer

Get notification preferences.

Respostas

200 Successful response.

Nome	Tipo	Descrição
categories	object	Per category ({memory, finance, capture, account}) channel switches.
digest	object
digest.enabled	boolean
digest.time	string
quietHours	object
quietHours.enabled	boolean
quietHours.start	string
quietHours.end	string
preview	"title" \| "full"	title keeps the memory content off the lock screen.

PATCH /v1/notifications/preferences Chave Bearer

Update notification preferences.

Partial merge of the preferences. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
categories	object	Per category ({memory, finance, capture, account}) channel switches.
digest	object
digest.enabled	boolean
digest.time	string
quietHours	object
quietHours.enabled	boolean
quietHours.start	string
quietHours.end	string
preview	"title" \| "full"	title keeps the memory content off the lock screen.

Respostas

200 Successful response.

Nome	Tipo	Descrição
categories	object	Per category ({memory, finance, capture, account}) channel switches.
digest	object
digest.enabled	boolean
digest.time	string
quietHours	object
quietHours.enabled	boolean
quietHours.start	string
quietHours.end	string
preview	"title" \| "full"	title keeps the memory content off the lock screen.

GET /v1/notifications/push Chave Bearer

Which push providers are configured on the server.

Respostas

200 Successful response.

Nome	Tipo	Descrição
fcm *	boolean
webpush *	boolean
vapidPublicKey *	string \| null

PUT /v1/notifications/push Chave Bearer

Register this device for push.

fcm needs pushToken (the Firebase registration token); webpush needs the browser subscription. With a device token the target is removed when the device is revoked. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
provider *	"fcm" \| "webpush"
pushToken	string	0–4096 chars
subscription	object
platform	string	e.g. android, ios, web.

Respostas

200 Successful response.

DELETE /v1/notifications/push Chave Bearer

Stop push to a token or endpoint.

Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
pushToken	string
endpoint	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
removed *	boolean

POST /v1/notifications/test Chave Bearer

Send a test notification.

Create a test notification in the inbox and push it. Requires the cortex.write scope.

Respostas

200 Successful response.

GET /v1/consolidation Chave Bearer

Get the daily consolidation.

Return the consolidation brief and conversation turns. Requires the Subscription plan.

Parâmetros

Nome	Tipo	Descrição
day	string (date) · query

Respostas

200 Successful response.

Nome	Tipo	Descrição
day *	string (date)
status *	"ready" \| "running" \| "failed" \| "none"
brief *	object \| null	Daily brief with generatedAt, summary, sections and questions.
brief.day	string (date)
brief.generatedAt	string (date-time)
brief.summary	string
brief.sections	object[]
brief.questions	object[]
turns *	object[]
turns[].id *	string
turns[].day *	string (date)
turns[].createdAt *	string (date-time)
turns[].transcript *	string
turns[].reply *	string
turns[].warning	string
turns[].actions *	object[]

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

POST /v1/consolidation/run Chave Bearer

Run the daily consolidation.

The operation is idempotent per day; force regenerates the consolidation. Requires the Subscription plan. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
force	boolean

Respostas

200 Successful response.

Nome	Tipo	Descrição
day *	string (date)
status *	"ready" \| "running" \| "failed" \| "none"
brief *	object \| null	Daily brief with generatedAt, summary, sections and questions.
brief.day	string (date)
brief.generatedAt	string (date-time)
brief.summary	string
brief.sections	object[]
brief.questions	object[]
turns *	object[]
turns[].id *	string
turns[].day *	string (date)
turns[].createdAt *	string (date-time)
turns[].transcript *	string
turns[].reply *	string
turns[].warning	string
turns[].actions *	object[]

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

GET /v1/consolidation/preferences Chave Bearer

Get consolidation preferences.

Return the daily consolidation schedule. Requires the Subscription plan.

Respostas

200 Successful response.

Nome	Tipo	Descrição
enabled *	boolean
time *	string
digestTime *	string

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

PATCH /v1/consolidation/preferences Chave Bearer

Update consolidation preferences.

Merge the supplied schedule preferences. Requires the Subscription plan. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
enabled	boolean
time	string
digestTime	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
enabled *	boolean
time *	string
digestTime *	string

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

POST /v1/consolidation/chat Chave Bearer

Add a turn to the consolidation conversation.

Send text or audio to discuss the daily brief. Requires the Subscription plan. Requires the cortex.write scope.

Corpo da requisição application/json

Respostas

200 Successful response.

Nome	Tipo	Descrição
id *	string
day *	string (date)
createdAt *	string (date-time)
transcript *	string
reply *	string
warning	string
actions *	object[]
actions[].id *	string
actions[].type *	string
actions[].status *	"applied" \| "failed" \| "undone"
actions[].summary *	string
actions[].nodeId *	string \| null
actions[].undoable *	boolean

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

POST /v1/consolidation/undo Chave Bearer

Undo a consolidation action.

Undo a reversible action from a conversation turn. Requires the Subscription plan. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
actionId *	string

Respostas

200 Successful response.

Nome	Tipo	Descrição
action *	object
action.id *	string
action.type *	string
action.status *	"applied" \| "failed" \| "undone"
action.summary *	string
action.nodeId *	string \| null
action.undoable *	boolean

402 The account needs the Subscription plan.

Nome	Tipo	Descrição
error *	"subscription_required"

PATCH /v1/comments/{id} Chave Bearer

Edit a comment.

Replace the comment body. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Comment id.

Corpo da requisição application/json

Nome	Tipo	Descrição
body *	string	1–5000 chars

Respostas

200 Successful response.

Nome	Tipo	Descrição
id *	string
nodeId *	string
body *	string
createdAt *	string (date-time)
updatedAt	string (date-time)

DELETE /v1/comments/{id} Chave Bearer

Delete a comment.

Remove the comment. Requires the cortex.write scope.

Parâmetros

Nome	Tipo	Descrição
id *	string · path	Comment id.

Respostas

204 Comment deleted.

POST /v1/uploads/known Chave Bearer

Check known upload hashes.

Return which hashes the user already stored, with their nodeId, so the client can skip re-uploading. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
hashes *	string[]

Respostas

200 Successful response.

Nome	Tipo	Descrição
known *	object[]
known[].sha256 *	string
known[].nodeId *	string

GET /v1/photos Chave Bearer

List photos.

List image and video memories ordered by capture time using cursor pagination. Supply changedSince to fetch photo-grid changes since a sync token.

Parâmetros

Nome	Tipo	Descrição
limit	integer · query	1–100, default 60
cursor	string · query	1–∞ chars
changedSince	string · query	Sync token from an earlier photo-list or delta response. · 1–∞ chars

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
nextCursor *	string \| null
syncToken *	string \| null	Token to use for the next photo-grid delta sync.
removed	string[]	Photo node IDs to remove from the local grid in delta mode.
reset	boolean	True when the supplied sync token is too old and the client must reload the full grid.

GET /v1/blobs/fetch/{requestId} Chave Bearer

Get the status of a machine blob fetch.

Return the status of a request to restore an evicted original attachment from a machine runner.

Parâmetros

Nome	Tipo	Descrição
requestId *	string (uuid) · path	Blob fetch request UUID.

Respostas

200 Successful response.

Nome	Tipo	Descrição
status *	"ready" \| "pending" \| "expired" \| "error"
url	string (uri)
expiresIn	number

POST /v1/blobs/replicated Chave Bearer

Check confirmed machine replicas for blob hashes.

Returns hashes that have a replica on a non-revoked machine runner.

Corpo da requisição application/json

Nome	Tipo	Descrição
sha256s *	string[]

Respostas

200 Successful response.

Nome	Tipo	Descrição
replicated *	object[]
replicated[].sha256 *	string
replicated[].size *	integer

GET /v1/context-packs Chave Bearer

List context packs.

List saved AI session handoff summaries (context packs), optionally filtered by platform.

Parâmetros

Nome	Tipo	Descrição
platform	string · query	Platform filter, e.g. chatgpt or claude.
limit	integer · query	Maximum number of packs to return. · 1–50, default 20

Respostas

200 Successful response.

Nome	Tipo	Descrição
packs *	object[]
packs[].id *	string
packs[].title *	string
packs[].platform *	string \| null
packs[].url *	string (uri)
packs[].savedAt *	string \| null

POST /v1/context-packs Chave Bearer

Save a context pack.

Save an AI session handoff summary to CortexPlus memory. Secrets in the content are replaced by placeholders before storing; the secret values are never persisted. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
content *	string	Handoff summary in Markdown.
platform *	string	AI platform that wrote the summary, e.g. chatgpt or claude.
key *	string	Short stable slug for the topic. Sending the same platform and key again updates the pack instead of creating another.
title	string
model	string
messageCount	integer	0–100000
tags	string[]

Respostas

201 Successful response.

Nome	Tipo	Descrição
id *	string
title *	string
url *	string (uri)
created *	boolean
redactions *	object[]
redactions[].kind *	string
redactions[].placeholder *	string
redactions[].count *	integer

POST /v1/context-packs/resume Chave Bearer

Resume a context pack.

Load a saved context pack by id or by semantic query to resume work started in another AI conversation.

Corpo da requisição application/json

Nome	Tipo	Descrição
query	string	Topic to find the pack by, in natural language.
id	string	Pack id, as returned by listContextPacks.
maxChars	integer	500–20000, default 6000

Respostas

200 Successful response.

Nome	Tipo	Descrição
text *	string
pack *	object \| null
pack.id	string
pack.title	string
pack.url	string (uri)
matches *	integer

GET /v1/study/due Chave Bearer

List due flashcards.

List study flashcards due for review, oldest first.

Parâmetros

Nome	Tipo	Descrição
subject	string · query	Subject name or slug (`materia:<slug>` tag) to filter by.
limit	integer · query	Maximum number of flashcards to return. · 1–100, default 20

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].ancestors	object[]
items[].interaction	object
items[].parent	object
items[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

POST /v1/study/review Chave Bearer

Review a flashcard.

Apply an SM-2 grade to a flashcard and return it with the new schedule. Returns 404 when the card does not exist. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
cardId *	string	Flashcard memory id.
grade *	"again" \| "hard" \| "good" \| "easy"

Respostas

200 Successful response.

Nome	Tipo	Descrição
card *	object	Full node as returned by the CortexPlus backend.
card.ancestors	object[]
card.interaction	object
card.parent	object
card.relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

POST /v1/study/quiz Chave Bearer

Generate a quiz.

Generate a multiple-choice quiz from the study material of a subject. Nothing is stored.

Corpo da requisição application/json

Nome	Tipo	Descrição
subject *	string	Subject name or slug.
count	integer	1–10, default 5

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
items[].question *	string
items[].options *	string[]
items[].answerIndex *	integer
items[].explanation *	string
items[].sourceId *	string \| null

GET /v1/modes Chave Bearer

List modes.

List the memory modes with per-user enabled flags and the selected mode.

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
selected *	string

POST /v1/modes/choose Chave Bearer

Choose the enabled modes.

Enable exactly the given modes, disable the others except `all`, and mark the first-run mode choice as done. Requires the cortex.write scope.

Corpo da requisição application/json

Nome	Tipo	Descrição
keys *	string[]

Respostas

200 Successful response.

Nome	Tipo	Descrição
items *	object[]
selected *	string

POST /v1/sales/brief Chave Bearer

Prepare a sales brief.

Summarize a client’s sales memories with the open deal, last contact, and next follow-up.

Corpo da requisição application/json

Nome	Tipo	Descrição
client *	string	Client name or slug.
includeClosed	boolean	Include closed opportunities.

Respostas

200 Successful response.

Nome	Tipo	Descrição
summary *	string
openDeal *
lastContactAt *	string \| null
nextFollowup *
sources *	string[]
clientNode *
comments *	object[]
comments[].id *	string
comments[].nodeId *	string
comments[].body *	string
comments[].createdAt *	string (date-time)
comments[].updatedAt *	string (date-time)
tasks *	object[]
tasks[].ancestors	object[]
tasks[].interaction	object
tasks[].parent	object
tasks[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
contacts *	object[]
contacts[].ancestors	object[]
contacts[].interaction	object
contacts[].parent	object
contacts[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
opportunities *	object[]
opportunities[].ancestors	object[]
opportunities[].interaction	object
opportunities[].parent	object
opportunities[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

GET /v1/sales/opportunities/{id} Chave Bearer

Get an opportunity with its related sales context.

Return an opportunity, its client, contacts, comments, tasks and related sales memories.

Parâmetros

Nome	Tipo	Descrição
id *	string · path

Respostas

200 Successful response.

Nome	Tipo	Descrição
node *	object	Full node as returned by the CortexPlus backend.
node.ancestors	object[]
node.interaction	object
node.parent	object
node.relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
client *
contacts *	object[]
contacts[].ancestors	object[]
contacts[].interaction	object
contacts[].parent	object
contacts[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
comments *	object[]
comments[].id *	string
comments[].nodeId *	string
comments[].body *	string
comments[].createdAt *	string (date-time)
comments[].updatedAt *	string (date-time)
tasks *	object[]
tasks[].ancestors	object[]
tasks[].interaction	object
tasks[].parent	object
tasks[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
related *	object[]
related[].ancestors	object[]
related[].interaction	object
related[].parent	object
related[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

404 Successful response.

Nome	Tipo	Descrição
error	string

GET /v1/finance/month Chave Bearer

Summarize a finance month.

Return expenses, income, spending by category against budgets, and upcoming bills for a month.

Parâmetros

Nome	Tipo	Descrição
month *	string · query	Month to summarize.
timezone	string · query	IANA time zone; defaults to the account setting.

Respostas

200 Successful response.

Nome	Tipo	Descrição
month *	string
currency *	string
expenses *	number
income *	number
byCategory *	object[]
byCategory[].category *	string
byCategory[].spent *	number
byCategory[].budget *	number \| null
upcomingBills *	object[]
upcomingBills[].ancestors	object[]
upcomingBills[].interaction	object
upcomingBills[].parent	object
upcomingBills[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.

GET /v1/health/summary Chave Bearer

Summarize health data.

Health data is only returned to API keys/agents when the user enabled `settings.healthAgentAccess`; otherwise the response is `{ "error": "health data is not shared with agents" }`. Summarize latest body metrics, 180-day series, flagged lab results, recent exams, routines and last workout.

Parâmetros

Nome	Tipo	Descrição
timezone	string · query	IANA time zone; defaults to the account setting.

Respostas

200 Successful response.

Nome	Tipo	Descrição
latest *	object
series *	object
flaggedResults *	object[]
flaggedResults[].nodeId *	string
flaggedResults[].date *	string
flaggedResults[].key *	string
flaggedResults[].name *	string
flaggedResults[].value *	number \| null
flaggedResults[].unit *	string \| null
flaggedResults[].flag *	"low" \| "high"
recentExams *	object[]
recentExams[].ancestors	object[]
recentExams[].interaction	object
recentExams[].parent	object
recentExams[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
routines *	object[]
routines[].ancestors	object[]
routines[].interaction	object
routines[].parent	object
routines[].relevance	object \| null	Computed relevance (not stored): score 0-100, level, reason codes. null when no scorer applies.
lastWorkout *

GET /v1/health/metric Chave Bearer

Get a health metric series.

Parâmetros

Nome	Tipo	Descrição
key *	string · query	Body metric key (weightKg, heightCm, bmi, bodyFatPct, muscleMassKg, visceralFat, bodyWaterPct, boneMassKg, basalMetabolismKcal, metabolicAge) or `lab:<resultKey>`, e.g. `lab:glicose`.
from	string (date) · query	First date in the metric series.
to	string (date) · query	Last date in the metric series.

Respostas

200 Successful response.

Nome	Tipo	Descrição
key *	string
unit *	string \| null
points *	object[]
points[].date *	string
points[].value *	number
points[].nodeId *	string
points[].source *	"measurement" \| "exam"

GET /v1/nutrition/history Chave Bearer

Get nutrient intake history.

Nutrient intake from logged meals, aggregated by day, week or month. Weekly and monthly values are daily averages over days with meals. Health-tagged memories hidden from the credential are excluded.

Parâmetros

Nome	Tipo	Descrição
from *	string (date) · query	First local date (inclusive).
to *	string (date) · query	Last local date (inclusive). Up to 366 days for `day`, 1830 for `week`/`month`.
granularity	"day" \| "week" \| "month" · query	Bucket size; weeks start on Monday. · default "day"
timezone	string · query	IANA time zone; defaults to the account setting.

Respostas

200 Successful response.

Nome	Tipo	Descrição
from *	string (date)
to *	string (date)
granularity *	"day" \| "week" \| "month"
timezone *	string
nutrients *	object[]
nutrients[].key *	string
nutrients[].unit *	string
buckets *	object[]
buckets[].start *	string (date)
buckets[].end *	string (date)
buckets[].days *	integer	Days with at least one meal.
buckets[].meals *	integer
buckets[].average *	object	Daily average over days with meals.
buckets[].total *	object	Values keyed by `<nutrient>:<unit>`, e.g. `enerc:kcal`, `procnt:g`, `vitc:mg`.
summary *	object
summary.days *	integer	Days with at least one meal.
summary.meals *	integer
summary.average *	object	Daily average over days with meals.
summary.total *	object	Values keyed by `<nutrient>:<unit>`, e.g. `enerc:kcal`, `procnt:g`, `vitc:mg`.

GET /v1/nutrition/targets Chave Bearer

Get recommended daily intake ranges.

Only returned to API keys/agents when the user enabled `settings.healthAgentAccess`; otherwise the response is `{ "error": "health data is not shared with agents" }`. Daily ranges per nutrient from the profile (birth date, sex, activity level), the latest weight/height and the active calorie goal; generic adult references when the profile is incomplete.

Parâmetros

Nome	Tipo	Descrição
timezone	string · query	IANA time zone; defaults to the account setting.

Respostas

200 Successful response.

Nome	Tipo	Descrição
profile *	object	Inputs used (birthDate, age, sex, activityLevel, weightKg, heightCm, calorieGoalKcal), `missing` fields and `supportedAge`.
basis *	"personal" \| "generic"
energyKcal *	object
energyKcal.value *	number
energyKcal.source *	"goal" \| "eer" \| "dv"
energyKcal.eer	number \| null
targets *	object[]
targets[].key *	string
targets[].unit *	string
targets[].min *	number \| null
targets[].max *	number \| null
targets[].target *	number \| null
targets[].source *	string

Quando algo dá errado

As falhas respondem com { "error": "..." } e um status correspondente: 401 sem chave, 403 quando a chave não pode escrever, 400 quando a requisição está malformada, 404 para um item desconhecido, 429 quando o limite do plano é atingido e 503 quando a memória está brevemente inacessível.

Atingir um limite nunca bloqueia a leitura — só pausa a indexação de novidades. Você pode aumentá-lo em Cobrança ou comparar planos na página de preços.