Korely Profile API

The Profile API from Korely — 1 operation(s) for profile.

GitHub OpenAPI

Operations 1

GET /v1/profile Get Profile #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/korely-ai:korely-ai-profile-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. 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 Specification

korely-ai-profile-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Korely Ai Profile API
  version: 1.0.21
  description: 'Operations tagged Profile 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: Profile
paths:
  /v1/profile:
    get:
      tags:
      - Profile
      summary: Get Profile
      description: 'The assembled profile of one end user: the active typed facts known about

        them, ``self``-facts first, grouped by predicate family. Deterministic (no

        model call). ``user_id`` is required: a profile is per-end-user (this is

        what distinguishes it from the flat ``GET /v1/facts`` list). ``as_of`` gives

        the point-in-time profile ("what was true on 2026-03-01"), ``known_as_of``

        the profile as the store knew it then ("what we knew on 2026-03-01").'
      operationId: get_profile_v1_profile_get
      security:
      - HTTPBearer: []
      parameters:
      - name: user_id
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
          description: End user to build the profile for.
          title: User Id
        description: End user to build the profile for.
      - name: agent_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter to one agent namespace.
          title: Agent Id
        description: Filter to one agent namespace.
      - name: as_of
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'ISO date/datetime: the profile as it was on that date, from 0001-01-02 to 9999-12-30, in UTC; outside it, or unreadable, a 422.'
          title: As Of
        description: 'ISO date/datetime: the profile as it was on that date, from 0001-01-02 to 9999-12-30, in UTC; outside it, or unreadable, a 422.'
      - name: known_as_of
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'ISO date/datetime: the facts as the store knew them then: learned by then, with the ends learned by then, true at `as_of` (default: that same moment). A move made in September and told in October: `as_of` September returns the new address, `known_as_of` September the old one. A moment from 0001-01-02 to 9999-12-30, in UTC; outside it, or unreadable, a 422.'
          title: Known As Of
        description: 'ISO date/datetime: the facts as the store knew them then: learned by then, with the ends learned by then, true at `as_of` (default: that same moment). A move made in September and told in October: `as_of` September returns the new address, `known_as_of` September the old one. A moment from 0001-01-02 to 9999-12-30, in UTC; outside it, or unreadable, a 422.'
      - name: exclude_sessions
        in: query
        required: false
        schema:
          type: boolean
          description: 'Leave out the facts only work sessions state (memories written with `kind: session`, what a coding assistant''s hooks save). Default false.'
          default: false
          title: Exclude Sessions
        description: 'Leave out the facts only work sessions state (memories written with `kind: session`, what a coding assistant''s hooks save). Default false.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
        '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. On this service also `quota_exceeded`: the plan''s queries of the month are spent (`limit`, `used`, `resets_at`, and no `Retry-After`: a retry fails until `resets_at` or a bigger plan).'
          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'
components:
  schemas:
    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.
    Fact:
      properties:
        id:
          type: string
          title: Id
          description: The fact's `fct_` id.
        subject:
          type: string
          title: Subject
          description: The subject as it was written.
        subject_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject Type
          description: 'What the subject is, as the write that stored the fact gave it: extraction gives one of `concept`, `event`, `organization`, `person`, `place`, `product`, `unknown`; a POST /v1/facts may have sent any type of up to 20 characters. A write that restates a fact already true keeps the type the fact was first stored with. `self` (lower case, matched exactly): GET /v1/profile counts a fact so typed as one about the end user and lists it first. The context block of GET /v1/context does not read the type: it tells the end user by the subject.'
        predicate:
          type: string
          title: Predicate
          description: 'The relation, canonical: `lives_in`.'
        predicate_raw:
          type: string
          title: Predicate Raw
          description: The relation as it was extracted.
        object:
          type: string
          title: Object
          description: The object as it was written.
        object_is_literal:
          type: boolean
          title: Object Is Literal
          description: True for a value (a date, an amount), false for an entity.
        predicate_family:
          anyOf:
          - type: string
          - type: 'null'
          title: Predicate Family
          description: 'The relation''s family: one of `preferences`, `people`, `places`, `work`, `ownership`, `health`, `financial`, `events`, `identity`, `other`.'
        confidence:
          anyOf:
          - type: number
          - type: 'null'
          title: Confidence
          description: '0 to 1: the extraction model''s own estimate for a fact read from a memory, what POST /v1/facts was sent (0.9 by default) for one written directly; a correction keeps the fact''s, and two facts a rename makes one keep the higher. A label, not a probability that the fact is true, and no read filters on it: a model''s declared confidence sits near 1 even when it is wrong.'
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: The end user the fact belongs to.
        agent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Id
          description: The agent namespace it was written under.
        valid_from:
          anyOf:
          - type: string
          - type: 'null'
          title: Valid From
          description: 'When it became true in the world: an ISO date/datetime from 0001-01-02 to 9999-12-30, in UTC; outside it, or unreadable, a 422.'
        invalid_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Invalid At
          description: When it stopped being true. Null while it holds, and, read with `known_as_of`, while the store had not learned the end yet.
        invalidated_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Invalidated By
          description: The `fct_` id of the fact that closed it.
        source_memory_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Memory Id
          description: The memory it was extracted from.
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: When the store learned the fact.
        closed_known_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Closed Known At
          description: When the store learned the fact had ended. Null while it is open.
        subject_canonical:
          type: string
          title: Subject Canonical
          description: The subject's current name, after its aliases and its object link.
        object_canonical:
          type: string
          title: Object Canonical
          description: The object's current name, after its aliases and its object link.
        subject_link_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject Link Id
          description: 'The object link that shows the subject under `subject_canonical`: two names of one thing the writer judged the same (memory_core 6.1.0, off by default). Null when none does.'
        object_link_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Object Link Id
          description: The same, for the object.
        tense:
          type: string
          title: Tense
          description: 'What the text said: current, past or planned.'
        last_confirmed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Confirmed At
          description: The last time a memory said it again.
        observation_count:
          type: integer
          title: Observation Count
          description: How many memories said it.
        source_memory_ids:
          items:
            type: string
          type: array
          title: Source Memory Ids
          description: Every memory that said it.
      additionalProperties: true
      type: object
      required:
      - id
      - subject
      - predicate
      - predicate_raw
      - object
      - object_is_literal
      - subject_canonical
      - object_canonical
      - tense
      - observation_count
      - source_memory_ids
      title: Fact
      description: 'A fact as a read answers it. A field added in a later release still

        passes (`extra` is allowed).'
    ProfileResponse:
      properties:
        user_id:
          type: string
          title: User Id
        as_of:
          anyOf:
          - type: string
          - type: 'null'
          title: As Of
        known_as_of:
          anyOf:
          - type: string
          - type: 'null'
          title: Known As Of
        facts:
          items:
            $ref: '#/components/schemas/Fact'
          type: array
          title: Facts
        by_family:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Fact'
            type: array
          type: object
          title: By Family
        total:
          type: integer
          title: Total
        truncated:
          type: boolean
          title: Truncated
      type: object
      required:
      - user_id
      - as_of
      - facts
      - by_family
      - total
      - truncated
      title: ProfileResponse
    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.
  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