v1 stable

    Reference docs
    for the machine‑auth
    link API.

    Operator-first surface for API-key auth, endpoint behavior, request schemas, error codes, and same-origin live testing.

    4 endpoints
    <50ms p99
    Bearer auth
    OpenAPI-backed
    POST /api/v1/links/shorten
    # Request
    curl -X POST \
    "https://1get.site/api/v1/links/shorten" \
    -H "Authorization: Bearer 1gt_live_••••••••" \
    -H "Content-Type: application/json" \
    -d '{ "url": "https://example.com/very-long-path"}'
    # 201 Created
    {
    "data": {
    "id": "lnk_01jf8x2a4m...",
    "short_url": "https://1get.site/my-link",
    "clicks": 0
    }
    }
    Current page
    Read current API usage

    Read current API usage

    Read current-month API usage, plan limit, reset date, and API key counts.

    Route
    GET
    /api/v1/usage
    Auth

    Scoped API key

    Required scopes

    usage:read

    Plan lane

    Requires an API-enabled paid plan.

    Response envelope

    `{ data: ... }` with stable error codes on failures

    Why this page exists

    Returns the current subscription usage snapshot for the organization behind the API key, including rate limit tier and active key counts for portal and automation tooling.

    Request reference

    Headers

    FieldTypeRequiredDescriptionExample
    Authorization
    string
    Optional
    Preferred authentication header. Send a scoped API key using the Bearer scheme.
    Bearer 1gt_live_1234567890abcdef
    X-API-Key
    string
    Optional
    Alternative authentication header. Use this only when Authorization headers are difficult to inject.
    1gt_live_1234567890abcdef
    X-Request-Id
    string
    Optional
    Optional caller-provided correlation ID. When omitted, 1get generates one and echoes it back in responses.
    req_a1f7f4bf

    Request discipline

    • Call this endpoint when you want to surface quota state in tooling or before launching larger automation batches.
    • The usage meter is subscription-level. Per-key request history remains a portal concern, not an external public contract.
    Rate limits and metering
    • This read lane is lighter than shorten, but still rate-limited and metered.
    • Polling it on every request is unnecessary. Cache it inside your worker or client for a short interval.
    Error model
    • API_SCOPE_FORBIDDEN means the key does not include usage:read.
    • SUBSCRIPTION_INACTIVE and API_ACCESS_DISABLED indicate the organization is no longer eligible for machine access.
    API_KEY_MISSING
    API_KEY_INVALID
    API_SCOPE_FORBIDDEN
    API_ACCESS_DISABLED
    RATE_LIMITED
    Next surface

    Create or rotate keys from the authenticated portal

    Use the dashboard portal when you need scoped key lifecycle management, entitlement visibility, and request activity history.