A unified digital network
Get Access

Documentation

ACCESS Documentation

Find your way around ACCESS, manage your account, and explore the workspace API. Can't find what you need? Contact support.

Quickstart

From account to first request.

  1. 01

    Create your account

    Create your account and follow the workspace onboarding steps.

    Get started
  2. 02

    Create a scoped key

    Create a key in Developer settings and keep it in your server environment.

    Developer settings
  3. 03

    Make your first request

    Send the key as a Bearer token and read back your handle and permissions.

    See the example

Getting started

Create your ACCESS account Create your account and follow the workspace onboarding steps.Understand your ACCESS ID Your username.access handle is your identity across the entire platform.Choosing the right Gift ACCESS, CREATE and BUILD: which one is right for you?Onboarding walkthrough What happens after you sign up, step by step.

Platform modules

Registry Create and manage objects — systems, blueprints, assets, and more.Projects End-to-end project management with full workspace context.Customers (CRM) Manage contacts, pipelines, and client relationships.Assets Upload, organize, and reference files, media, and documents.Vaults Organize workspace knowledge and manage access to stored material.Workflows Build automated sequences that run across your platform.Offers Create and manage your products, services, and proposals.Memory Long-term workspace memory that JYSON reads across sessions.

JYSON — AI intelligence

What is JYSON? JYSON is your AI operator — not a chatbot. It knows your workspace context.JYSON message limits How message counts work per plan and when they reset.JYSON memory system How persistent memory works and how JYSON compounds across sessions.JYSON and your data What data JYSON can access and how it processes workspace context.

Gifts and billing

Gift billing overview Gifts, recurring pricing, and payment methods including ACH.Managing your Gift Change or cancel your recurring Gift and update its payment method.ACH bank transfer guide How to set up ACH payment for lower processing fees.Refund policy 30 days annual, 7 days monthly. How to request a refund.

Account and security

Account settings Manage your profile, handle, and account preferences.Link Nostr to ACCESS NIP-07 key app + proof — not a one-click social login. Step-by-step how-to.Security overview Encryption, authentication, and how your data is protected.Privacy request (FDBR) How to request access, export, correction, or deletion of your data.Delete your account How to permanently close your ACCESS account.

Workspace API

Live · Beta

Start in Developer settings to create a scoped API key. Send it in the Authorization header as a Bearer token. Keep keys in your server environment, never in public browser code or a shared repository. Revoke a key in Developer settings when you no longer need it.

The beta API currently exposes these routes. Each request acts as the identity that owns the key.

GET
/api/v1/customersScope: readList your workspace customers.
POST
/api/v1/customersScope: customers:writeCreate a customer in your workspace with explicit write permission and an Idempotency-Key header.
GET
/api/v1/meScope: Valid keyRead your ACCESS handle and granted scopes. Vault summaries require the read scope.
GET
/api/v1/vault/search?q=your-queryScope: readSearch excerpts from your synced vault content.
POST
/api/v1/jyson/askScope: jysonSend a JSON question for a JYSON response.
GET
/api/v1/modelsScope: jysonList models supported by the Zin gateway.
POST
/api/v1/chat/completionsScope: jysonUse the OpenAI-compatible chat format with the Zin gateway.

Download the OpenAPI reference →

Make your first request

curl https://getaccess.world/api/v1/me -H "Authorization: Bearer $ACCESS_API_KEY"

A successful identity response includes ok, handle, scopes, and vaults. New keys expire within 90 days; choose a shorter lifetime in Developer settings. Existing keys retain their current expiry policy. Revoke a key immediately if it is exposed. Requests are limited to 120 per minute per key, with 10 intelligence requests per minute. A 429 response includes Retry-After. Missing, expired, or revoked keys return an authentication error; a key without a required scope cannot use that endpoint. Vault results require synced content. JYSON requests also depend on the deployment's model configuration and usage controls.

Get API keysOpenAPI reference

Can't find what you need?

Contact supportHelp Center