Korely Account API
The account API from Korely — 2 operation(s) for account.
The account API from Korely — 2 operation(s) for account.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/korely-ai:korely-ai-account-api"
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.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Korely Ai Account API
version: 1.0.21
description: 'Operations tagged account across 2 of this provider''s published API definitions: korely-ai-agent-openapi.json, korely-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.korely.ai
description: EU (Helsinki)
tags:
- name: Account
paths:
/v1/agents/init:
post:
tags:
- Account
summary: Create an account and its first key, without a login
description: 'Create an account with no login, its Default project and a key valid
for 7 days, in one call and with no key: 201 with the key, shown this
once, and when it stops working (`expires_at`, ISO 8601 with its time
zone, the name the key listing uses). `note` says it in words: the key
is valid 7 days; until the account is adopted it is on trial (40 writes
in all, at most 5 writes and 20 requests a minute, a wait that grows
past the 5 writes, no other keys); signing in to the dashboard (its
address is in the sentence) with this key adopts the account, which
lifts these limits and this key''s end date, and the account''s keys are
then made there. After its date, if nobody adopted the account before
it, the key gets 401 `invalid_key` on every /v1 and /admin route, the
MCP door''s own 401 `invalid_token`, and 404 `key_not_found` from the
adoption.
The trial, until a person adopts the account (signs in to the dashboard
with this key): 40 writes in all, for the account''s whole life, plus a
10% grace (the 45th is refused: 429 `quota_exceeded`, `resets_at` null,
no `Retry-After`); at most 20 requests a minute, reads and writes
together; at most 5 writes in one clock minute (UTC), the burst. The 6th
write of a minute is a strike: 429 `rate_limit_exceeded` with
`Retry-After` in whole seconds, rounded up, and every write is refused
until the wait ends. The waits are 60, 120, 240, 480 s for the 1st to
4th strike of the last hour, then 480. `POST /v1/batch` takes one place
of the 5 and as many of the 40 as its memories. Until it is adopted the
account makes no keys: POST /admin/keys answers 403
`account_not_adopted`. Adoption lifts these limits from the next
request on, and this key''s 7-day end with the adoption itself: the key
then has no end date (`expires_at` null in GET /admin/keys).
`quotas` gives the plan''s monthly numbers, which apply after adoption,
not the trial''s. The reply also carries the Terms that creating the
account accepts. `processing_region` picks where the models that write
its memories run.
403 `signup_disabled` while sign-ups are closed; 429
`signup_rate_limited` past the day''s new accounts, of every network or
of the caller''s.'
operationId: init_agent_v1_agents_init_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/InitBody'
- type: 'null'
title: Body
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/InitResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'413':
description: '`payload_too_large`: the body is larger than 2,097,152 bytes, the most this route takes. Refused before it is read; nothing was done. Also a body that holds more JSON strings (36,930), values (72,433) or characters (342,092) than lawful items of its size can, whose text decodes to more than it weighs and more than 4,077,000 bytes, or that would take more than 8,388,608 bytes once decoded: refused before it is decoded; nothing was done.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'408':
description: '`request_timeout`: the body did not arrive whole within 30 s. Nothing was done; send it again.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'400':
description: '`bad_request`: the body is not well formed. A JSON body not in UTF-8 (RFC 8259) is refused before it is decoded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'503':
description: '`unavailable`: the server holds as many request bodies as it reads at once; retry after `Retry-After` (5 s). Nothing was done. Also `unavailable` when the request waited more than 5 s for another change to the same records (an erasure under way, for example) or its statement ran past 60 s; see `Retry-After`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v1/account:
delete:
tags:
- Account
summary: Delete the account of this key (accounts made with POST /v1/agents/init)
description: 'Delete, for good, the account this key belongs to: every key, project,
memory and fact, and its subscription at Polar if it has one. Only for an
account made with POST /v1/agents/init that nobody signs in to; 409
`account_has_login` for one with a login, which closes from the
dashboard. 400 `confirmation_required` without `?confirm=true`. The
reply counts the rows removed per table. Needs the `admin` scope: the key
`POST /v1/agents/init` returns holds it, and a key made later without it,
or confined to some end users, answers 403 `forbidden` (since 1.0.5).'
operationId: delete_account_v1_account_delete
security:
- HTTPBearer: []
parameters:
- name: confirm
in: query
required: false
schema:
type: boolean
description: 'Must be true: the account, its keys and every memory are deleted for good.'
default: false
title: Confirm
description: 'Must be true: the account, its keys and every memory are deleted for good.'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDeleted'
'401':
description: '`invalid_key`: the `Authorization: Bearer` key is missing, unknown, revoked or expired.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: '`forbidden`: the key lacks the scope this operation needs; `message` names it.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'422':
description: '`invalid_request`: the body, a query parameter or a path parameter is malformed (`detail` lists the first 20 fields that failed, `message` names the first and counts them all), or the endpoint refuses a value (an empty content, an unreadable timestamp, a NUL byte or a lone UTF-16 surrogate anywhere in the request, a moment that cannot be stored, which is any but from 0001-01-02 to 9999-12-30, in UTC; `detail` is a sentence or `{code, message}`).'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'429':
description: '`rate_limit_exceeded`: past the request ceiling, the per-minute one set on this install (`RATE_LIMIT_PER_MINUTE`) or, on the hosted service, the plan''s minute, hour or day; `message` names the window and `Retry-After` the seconds until it resets.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: '`internal_error`: the server failed on this request; `message` holds no detail of it.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'503':
description: 'A dependency did not answer: the database while the key was checked (`unavailable`, see `Retry-After`), or the one `code` names. Nothing was written; retry. Also `unavailable` when the request waited more than 5 s for another change to the same records (an erasure under way, for example) or its statement ran past 60 s; see `Retry-After`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'400':
description: '`confirmation_required`: `?confirm=true` is missing.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: '`account_has_login`: the account has a login; close it from the dashboard.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
InitResult:
properties:
api_key:
type: string
title: Api Key
tier:
type: string
title: Tier
region:
type: string
title: Region
description: Where the data is stored.
processing_region:
type: string
title: Processing Region
description: 'Where the models that write the Default project''s memories run: global, or eu (a provider in the European Union).'
scopes:
items:
type: string
type: array
title: Scopes
expires_at:
type: string
format: date-time
title: Expires At
description: 'When the key stops working: 7 days after it is made (ISO 8601, with its time zone). From then on every door refuses it, the adoption included. Sign in to the dashboard with it before then: that adopts the account and lifts this end date (the key then has none, and keeps writing and reading its project, but no key of the account manages it any more), and the account''s keys are made there.'
note:
type: string
title: Note
description: 'The same, in words: how long the key lasts, the trial''s limits until the account is adopted (no other keys among them), and how to adopt it.'
quotas:
additionalProperties: true
type: object
title: Quotas
description: The free plan's numbers, which apply once the account is adopted; until then the trial's, in `note`.
terms_url:
type: string
title: Terms Url
description: The Terms of Service. Creating the account accepts them, for whoever operates the agent and holds the key.
privacy_url:
type: string
title: Privacy Url
description: The Privacy Policy.
type: object
required:
- api_key
- tier
- region
- processing_region
- scopes
- expires_at
- note
- quotas
- terms_url
- privacy_url
title: InitResult
ErrorCode:
properties:
code:
type: string
title: Code
description: Stable, machine-readable reason, e.g. `not_found`, `stale_write`, `invalid_request`, `search_unavailable`. Branch on this, never on `message`.
examples:
- not_found
message:
type: string
title: Message
description: What went wrong, for a person to read. Wording may change.
type: object
required:
- code
- message
title: ErrorCode
description: A refusal with a stable reason.
AccountDeleted:
properties:
deleted:
type: boolean
title: Deleted
default: true
removed:
additionalProperties:
type: integer
type: object
title: Removed
type: object
title: AccountDeleted
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
ApiError:
properties:
detail:
anyOf:
- type: string
- $ref: '#/components/schemas/ErrorCode'
- items:
$ref: '#/components/schemas/ValidationIssue'
type: array
title: Detail
description: 'As this install has always sent it: a sentence; or `{code, message}` where the endpoint names the reason; or, on a 422 from validation, the list of fields that failed.'
code:
type: string
title: Code
description: 'Stable, machine-readable reason, the same names as the hosted API: `invalid_key`, `forbidden`, `not_found`, `stale_write`, `invalid_request`, `identity_required` (a write with neither user_id nor agent_id), `rate_limit_exceeded`, `search_unavailable`, `model_unavailable`, `service_paused`, `internal_error`... When `detail` is `{code, message}` it is that code. Branch on this, never on `message`.'
examples:
- not_found
message:
type: string
title: Message
description: 'What went wrong, for a person to read: the sentence, the message of `detail`, or the first field that failed validation. Wording may change.'
current_fact_id:
anyOf:
- type: string
- type: 'null'
title: Current Fact Id
description: '`fact_not_current`: the fact in force to correct instead, null when nothing took the fact''s place. Absent on every other refusal.'
type: object
required:
- detail
- code
- message
title: ApiError
description: The body of every answer that is not a success, whatever the status.
ValidationIssue:
properties:
type:
type: string
title: Type
description: What kind of failure, e.g. `missing`, `extra_forbidden`, `string_too_long`, `invalid_namespace_id`.
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Loc
description: 'Where: `body`, `query` or `path`, then the field, e.g. ["body", "memories", 0, "user_id"].'
msg:
type: string
title: Msg
description: What is wrong with it, for a person to read.
ctx:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Ctx
description: The limit that was crossed, when there is one.
type: object
required:
- type
- loc
- msg
title: ValidationIssue
description: One field that failed validation. The value sent is never echoed back.
InitBody:
properties:
agent_caller:
anyOf:
- type: string
maxLength: 120
- type: 'null'
title: Agent Caller
description: Who is signing up, e.g. 'claude-code'. A free-form label, kept for your reference.
processing_region:
anyOf:
- type: string
enum:
- eu
- global
- type: 'null'
title: Processing Region
description: 'Where the models that write your memories run, for the account''s Default project: ''global'' (the default) or ''eu'' (a provider in the European Union). Where the data is stored does not change with it (`region`). Changeable later per project.'
type: object
title: InitBody
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
bearerAuth:
type: http
scheme: bearer
description: Your kor_live_ API key.
x-refined-from:
- korely-ai-agent-openapi.json
- korely-ai-openapi.json