Skip to content
Ask LucyAsk LucyAsk Lucy Docs

Who is calling

GET
/me
curl --request GET \
  --url https://api.asklucy.eu/v1/me \
  --header 'Authorization: Bearer <token>'

The signed-in user (or service user), their organization, roles and what the organization is entitled to.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
user
required
object
id
required

Zitadel user ID.

string
name
required
string
email
string | null format: email
kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string
Allowed values: person service agent
organization
required
object
id
required

Zitadel organization ID.

string
name
required
string
roles
required
Array<string>
Allowed values: member org_admin auditor
entitlements
required

What the customer’s contract allows.

object
sandbox
required

Lucy may run code for this organization.

boolean
max_file_size_bytes
required
integer
max_files_per_conversation
required
integer
memory
required

Lucy Memory (processes and knowledge graph) is part of the contract.

boolean
usage

The caller’s usage, Claude Code style: per window, the share used and when it resets. Only windows that limit the caller are listed; an empty list means no limits apply.

object
windows
required
Array<object>

How much of one window a member has used. No amounts.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
can_choose_model

Whether the caller may choose the model of their conversations (GET /models lists them).

boolean
default_model
One of:
object
id
required
string
label
required
string
can_web_search

Whether the organization lets the caller use web search (its web_search, and a grant when it is selected). When true, Lucy has web search in all their conversations and uses it when a question needs it; there is no switch per person or conversation.

boolean
can_use_agents

Whether the organization lets the caller make and run agents (its agents, the caller’s roles, and a grant when it is selected).

boolean
pending_requests

Admins (org_admin) only, absent for others. Requests from members waiting for a decision (GET /org/requests?status=pending).

integer
sso
One of:

The organization’s identity provider, for everyone to know how they sign in.

object
kind
required

Microsoft Entra ID, Google Workspace, or any OpenID Connect provider (Okta, Keycloak, Authentik…).

string
Allowed values: entra google oidc
name
required
string
enforced
required
boolean

Example 

{
  "user": {
    "kind": "person"
  },
  "roles": [
    "member"
  ],
  "usage": {
    "windows": [
      {
        "window": "five_hours",
        "limited_by": "personal",
        "request": {
          "status": "pending"
        }
      }
    ]
  },
  "sso": {
    "kind": "entra"
  }
}

401

Section titled “401”

Missing, expired or invalid token.

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
quota

For quota-exceeded, the window that is used up.

object
window
required
string
Allowed values: five_hours week month
percent_used
required
number
<= 100
resets_at
required

Null for a rolling window that hasn’t started.

string | null format: date-time
limited_by
required

organization when the organization’s budget is closer to running out than the member’s own limit.

string
Allowed values: personal organization
request
One of:

A request as its member sees it, where they asked.

object
id
required
string
status
required
string
Allowed values: pending approved declined withdrawn
created_at
required
string format: date-time
decided_at
required
string | null format: date-time
note
required

What the admin who decided wrote back.

string | null
errors

Field-level problems (400 only).

Array<object>
object
field
required

JSON pointer into the request body.

string
message
required
string

Example 

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Unique per request; quote it to support.