Documentation

ACCESS Documentation

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

Getting started

Platform modules

JYSON — AI intelligence

Gifts and billing

Account and security

Workspace API

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/customers

Scope: read List your workspace customers.

POST /api/v1/customers

Scope: customers:write Create a customer in your workspace with explicit write permission and an Idempotency-Key header.

GET /api/v1/me

Scope: Valid key Read your ACCESS handle and granted scopes. Vault summaries require the read scope.

GET /api/v1/vault/search?q=your-query

Scope: read Search excerpts from your synced vault content.

POST /api/v1/jyson/ask

Scope: jyson Send a JSON question for a JYSON response.

GET /api/v1/models

Scope: jyson List models supported by the Zin gateway.

POST /api/v1/chat/completions

Scope: jyson Use 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.

API Access

Workspace API · Beta

Explore authenticated workspace endpoints for identity, vault search, and JYSON. Create scoped keys in Developer settings.

Get API keys