> ## Documentation Index > Fetch the complete documentation index at: https://docs.lumeus.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get your workspace > Returns the workspace (organization) the key or session belongs to: its name and plan, the current billing period and its Mainnet credit usage, today's free Testnet requests (`testnet`), and the API base URLs. A verified dashboard session creates its workspace on first use. Served by the Activity host for all products. Read-only and publishable keys get 403. ## OpenAPI ````yaml /api-reference/activity.json get /v1/me openapi: 3.0.3 info: title: Lumeus Activity API version: '2026-09-15' description: >- Lumeus Activity API on Stellar. Sign up at https://app.lumeus.dev: Free, Starter, Growth and Scale plans are self-serve, Enterprise by agreement. - **Pricing.** Testnet is free: Testnet requests cost no credits and are never billed. Each organization can make 10,000 Testnet requests a day across Activity, Assets and RPC (unlimited on Enterprise); the count resets at 00:00 UTC, and a request over it answers 429 rate_limited with Retry-After set to the seconds until then. Mainnet requests draw from the plan's monthly credits. Plans, limits and credit weights: `GET https://api.lumeus.dev/v1/plans`. - **Authentication.** Send `Authorization: Bearer `. Testnet: `lum_test_…`; Mainnet: `lum_live_…`. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable `lum_pub_…` keys call the GET data routes only, from an allowed browser origin. Webhook keys (`whk_…`) are not accepted here. - **Headers.** Every response except `GET /readyz` carries X-Request-Id; authenticated responses carry RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; 429 and 503 carry Retry-After. - **Errors.** JSON with a machine-readable code (see [errors](/guides/errors)). A path with an empty, `.` or `..` segment answers 400 invalid_request, a trailing slash answers 404 not_found, and a method the path does not accept answers 405 with an Allow header. - **CORS.** Browser calls (CORS) are allowed from https://docs.lumeus.dev (the Try it playground of this reference) and https://app.lumeus.dev only, without cookies; responses expose ETag, Link, Location, Retry-After, X-Request-Id, X-Lumeus-Operation-Id, X-Lumeus-Idempotency and RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (errors included). Other websites cannot read responses made with a server key: use a publishable key with your own allowed origins ([browser keys](/guides/browser-keys)). license: name: Lumeus API contract servers: - url: https://api-testnet.lumeus.dev description: Testnet (default) - url: https://api.lumeus.dev description: Mainnet security: - Bearer: [] tags: - name: Queries description: >- Decoded Stellar history: the token movements and contract events of an account, asset, contract or transaction, the network feed, contract-event topic search and transaction headers. - name: Results description: >- Recover the saved result of a long prepaid request without running it again. Only prepaid accounts receive operation IDs; every other account gets 404 here. - name: Workspace description: >- Your workspace (organization): its name, plan, current period usage and API base URLs. Served by the Activity host for every product. - name: API keys description: >- Create, list, update, rotate and revoke the `lum_` keys used by the Activity API, the Assets API and RPC. - name: Usage description: >- Credits and requests used, the free Testnet daily count, per-route breakdowns, time series and the request log of your keys. - name: Billing description: >- The public plan catalog, plan subscriptions through Stripe Checkout, the billing portal and payment status. - name: Retired description: >- Routes kept only so old clients get a clear answer. Do not use them in new code. - name: Health description: Liveness and readiness probes for monitoring. No authentication. paths: /v1/me: get: tags: - Workspace summary: Get your workspace description: >- Returns the workspace (organization) the key or session belongs to: its name and plan, the current billing period and its Mainnet credit usage, today's free Testnet requests (`testnet`), and the API base URLs. A verified dashboard session creates its workspace on first use. Served by the Activity host for all products. Read-only and publishable keys get 403. operationId: getYourWorkspace responses: '200': description: The workspace, its plan and the current period usage. content: application/json: schema: $ref: '#/components/schemas/Account' example: api_base_urls: mainnet: https://api.lumeus.dev testnet: https://api-testnet.lumeus.dev billing_enabled: false billing_linked: false key_used: true monthly_credits_used: 54269 monthly_requests: 14954 network: testnet onboarded: true org: id: 00000000-0000-4000-8000-000000000000 name: my-app plan: enterprise period: '2026-10-20' period_end: '2026-11-20T09:04:24Z' period_start: '2026-10-20T09:04:24Z' prepaid_balance: 0 prepaid_enabled: false rate_limit_per_minute: 30000 testnet: free: true day: '2026-10-22' daily_requests_used: 1234 daily_requests_limit: null daily_requests_remaining: null resets_at: '2026-10-23T00:00:00Z' headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ RateLimit-Limit: description: >- Requests per minute of the bucket that answered: the plan rate, the dashboard session floor of 120, or a publishable key's per-IP rate. schema: type: integer RateLimit-Remaining: description: Whole requests left in the bucket after this one. schema: type: integer RateLimit-Reset: description: Seconds until the bucket is full again. schema: type: integer '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403_3' '405': $ref: '#/components/responses/HTTP405_10' '429': $ref: '#/components/responses/HTTP429_3' '503': $ref: '#/components/responses/HTTP503_6' x-codeSamples: - lang: bash label: cURL source: |- curl --fail-with-body -sS 'https://api-testnet.lumeus.dev/v1/me' \ -H "Authorization: Bearer $LUMEUS_API_KEY" - lang: javascript label: JavaScript source: |- // Node 18+ (ES module) const res = await fetch('https://api-testnet.lumeus.dev/v1/me', { method: 'GET', headers: { Authorization: `Bearer ${process.env.LUMEUS_API_KEY}`, }, }); console.log(res.status, JSON.stringify(await res.json(), null, 2)); - lang: python label: Python source: |- import json import os import requests res = requests.get( "https://api-testnet.lumeus.dev/v1/me", headers={"Authorization": f"Bearer {os.environ['LUMEUS_API_KEY']}"}, timeout=30, ) print(res.status_code, json.dumps(res.json(), indent=2)) components: schemas: Account: type: object properties: org: type: object properties: id: type: string format: uuid name: type: string plan: type: string period: type: string network: type: string enum: - mainnet - testnet onboarded: type: boolean key_used: type: boolean description: Any key in the workspace has authenticated a request. billing_enabled: type: boolean billing_linked: type: boolean prepaid_enabled: type: boolean funding: $ref: '#/components/schemas/Funding' period_start: type: string format: date-time description: Start of the current billing period (plan accounts). period_end: type: string format: date-time description: End of the current billing period (plan accounts). rate_limit_per_minute: type: integer description: Activity organization rate; RPC has its own rate. monthly_credits_used: type: integer description: >- Credits used this period. Mainnet only: Testnet requests cost no credits. monthly_requests: type: integer description: >- Requests this period on both networks, including free Testnet requests (0 credits each). prepaid_balance: type: integer monthly_credits_limit: type: integer description: >- Credits included in the plan this period. Absent for prepaid accounts. monthly_credits_remaining: type: integer description: Included credits left this period. Absent for prepaid accounts. hard_cap: type: boolean request_count_semantics: type: string description: >- Prepaid accounts only: what monthly_requests counts (operations, finalized deliveries and source scans, not HTTP attempts). api_base_urls: type: object properties: mainnet: type: string testnet: type: string testnet: type: object properties: free: type: boolean description: 'Always true: Testnet requests cost no credits.' day: type: string description: Current UTC date (YYYY-MM-DD). format: date daily_requests_used: type: integer description: >- Testnet requests admitted today across Activity, Assets and RPC; each JSON-RPC batch call counts. minimum: 0 daily_requests_limit: type: integer description: >- The plan's daily Testnet request cap (10000); null on Enterprise (unlimited). nullable: true daily_requests_remaining: type: integer description: Requests left today; null on Enterprise. minimum: 0 nullable: true resets_at: type: string format: date-time description: Next 00:00 UTC, when the count resets. required: - free - day - daily_requests_used - daily_requests_limit - daily_requests_remaining - resets_at description: >- Free Testnet usage today against the daily cap. On a Free plan, for example: `"testnet": {"free": true, "day": "2026-10-22", "daily_requests_used": 1234, "daily_requests_limit": 10000, "daily_requests_remaining": 8766, "resets_at": "2026-10-23T00:00:00Z"}`. Omitted only if the counter cannot be read. Funding: type: object properties: policy_version: type: string resource_policy_version: type: string period: type: string state: type: string as_of: type: string format: date-time admission_allowed: type: boolean available_credits: type: integer included_available: type: integer prepaid_available: type: integer held_credits: type: integer consumed_credits_all_periods: type: integer period_credits: type: integer period_requests: type: integer open_operations: type: integer resources: type: array items: type: object properties: dimension: type: string capacity: type: integer held: type: integer available: type: integer Error: type: object properties: error: type: string description: Human-readable message. It may change; branch on code. code: type: string description: >- Machine-readable error code. Branch on code, not on the error text, which may change. RPC carries the same codes as the string error.data of a JSON-RPC error. invalid_request: 400: invalid input, including a malformed Idempotency-Key or an unknown or repeated query parameter (Webhooks also uses it for an oversized request body, 413). Fix the request; do not retry unchanged. unauthorized: 401: missing, revoked, invalid or wrong-network credential. payment_required: 402 (Mainnet): monthly credit quota exhausted on a hard-capped plan. forbidden: 403: the key or account policy does not allow this action. not_found: 404 (Webhooks also 410): the resource does not exist in this organization and network. topic_search_disabled: 404: contract-event topic search is not enabled on this network. method_not_allowed: 405: the route does not accept this method. conflict: 409: conflicting request identity, idempotency key, funding or recovery state. generation_changed: 409: the index generation or network changed since the snapshot was taken; restart the walk without generation and snapshot_ledger. history_unavailable: 409 (Assets): as_of_ledger is not answered from the balance history; start a snapshot job (POST /snapshots) or retry later. precondition_failed: 412 (Webhooks): the subscription version changed; fetch the current ETag. response_too_large: 413: the result exceeds the response budget; lower limit or narrow the request. precondition_required: 428 (Webhooks): If-Match with the subscription ETag is required. rate_limited: 429: a rate, concurrency or credit-cap limit was reached, or (Activity, Assets and RPC on Testnet) the daily Testnet request cap (message `daily Testnet request cap of 10000 reached; resets at 00:00 UTC`, Retry-After until 00:00 UTC). Wait Retry-After seconds (a refused request consumes nothing). A Retry-After greater than 60 means the daily Testnet cap: wait until 00:00 UTC or switch to Mainnet. RPC carries it as the string error.data. internal_error: 500 or another unexpected 5xx; quote request_id when contacting support. not_implemented: 501: the feature is not enabled on this host. busy: 503: reads are saturated (the queue wait expired or the database refused another query or ran short of memory). Retry the same request after Retry-After (2) seconds. query_timeout: 503: the read ran out of time. Do not retry unchanged right away: narrow the ledger range (since_ledger/until_ledger) or lower limit; Retry-After is 30. index_not_ready: 503: the index or snapshot is not ready yet or is rebuilding; retry after Retry-After seconds. topic_coverage: 503: the effective range is outside the contract-event topic index coverage (the message states it); pass a range inside it or retry after Retry-After (60) seconds. unavailable: 503: another temporary failure (billing, rate limiter, queue); retry after Retry-After seconds. enum: - invalid_request - unauthorized - payment_required - forbidden - not_found - topic_search_disabled - method_not_allowed - conflict - generation_changed - history_unavailable - precondition_failed - response_too_large - precondition_required - rate_limited - internal_error - not_implemented - busy - query_timeout - index_not_ready - topic_coverage - unavailable request_id: type: string description: >- Identifier of this request, the same value as the X-Request-Id header. Quote it when contacting support. required: - error responses: HTTP401: description: >- Missing, invalid, revoked or expired key, or a key for the other network (code unauthorized). Keys work only on the network they were created for. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: unauthorized error: missing credentials request_id: req_6f1c2a9b0e4d4c7a8b3f5e21 headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ HTTP403_3: description: >- This key or account cannot call this route (code forbidden): for example a read-only key on a workspace route, or a publishable key on a route or from an origin it does not allow. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: forbidden error: >- this API key is read-only; use a full-access key or a signed-in session request_id: req_6f1c2a9b0e4d4c7a8b3f5e21 headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ HTTP405_10: description: >- This path does not accept the HTTP method you sent (code method_not_allowed). The Allow header lists the methods it accepts. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: method_not_allowed error: 'method POST is not allowed on /v1/me; allowed: GET, HEAD, PATCH' request_id: req_6f1c2a9b0e4d4c7a8b3f5e21 headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ HTTP429_3: description: >- The rate limit of this route was reached (code rate_limited). Wait Retry-After seconds. This route does not count toward the daily Testnet request cap, so its Retry-After is never the time until 00:00 UTC. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: rate_limited error: rate limit exceeded request_id: req_6f1c2a9b0e4d4c7a8b3f5e21 headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ RateLimit-Limit: description: >- Requests per minute of the bucket that answered: the plan rate, the dashboard session floor of 120, or a publishable key's per-IP rate. schema: type: integer RateLimit-Remaining: description: Whole requests left in the bucket after this one. schema: type: integer RateLimit-Reset: description: Seconds until the bucket is full again. schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer HTTP503_6: description: >- Temporarily unavailable (code unavailable). Wait Retry-After seconds and retry; do not assume the request failed permanently. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: unavailable error: funding usage unavailable request_id: req_6f1c2a9b0e4d4c7a8b3f5e21 headers: X-Request-Id: description: >- Identifier of this request: req_ followed by 24 hex characters. Error bodies repeat it as request_id. Quote it when contacting support. schema: type: string pattern: ^req_[0-9a-f]{24}$ Retry-After: description: Seconds to wait before retrying. schema: type: integer securitySchemes: Bearer: type: http scheme: bearer description: >- Send `Authorization: Bearer `. Testnet: `lum_test_…`; Mainnet: `lum_live_…`. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable `lum_pub_…` keys call the GET data routes only, from an allowed browser origin. Webhook keys (`whk_…`) are not accepted here. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.