API reference

Keys

The calling key itself, and the claim url of an anonymous workspace.

POST Get a claim url for an anonymous workspace
GET Describe the calling key

POST /claim-code claim:create #

Get a claim url for an anonymous workspace

Replaces the calling anonymous key's claim code and returns claim_url plus claim_expires_at. Hand the url to a human: opening it while signed in makes the temporary workspace a permanent team. Only anonymous keys carry claim:create. Any earlier claim url stops working.

Response 200 application/json

data object required
- claim_url string required
- claim_expires_at string required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
409 Conflict
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X POST "https://api.uptizm.com/v1/claim-code" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch('https://api.uptizm.com/v1/claim-code', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/claim-code');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
        'Idempotency-Key: '.uniqid('', true),
    ],
]);

$response = curl_exec($curl);

import os
import uuid

import requests

response = requests.post(
    "https://api.uptizm.com/v1/claim-code",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)

print(response.json())

Try it

API key This runs against my live workspace

GET /me any key #

Describe the calling key

Returns the key's team, the team's plan and limits, and the key itself (name, abilities, expiry, kind). Any valid key may call it, whatever abilities it carries; use it to check a key works and what it can do.

Response 200 application/json

data object required
- team object required
  - id string required
  - name string required
- plan string, one of "anonymous", "free", "starter", "pro", "enterprise" required
- limits object required
- key object or null required
  - name string required
  - abilities string required
  - expires_at string or null required
  - kind string, one of "team", "anonymous" required

Errors

401 Unauthenticated
403 The key lacks the ability this endpoint requires (required_ability names it), or the action is not allowed for the team.
404 Not found
429 Rate limited. Each key may make 120 reads (GET) and 30 writes per minute; wait for Retry-After seconds.

Code samples

curl -X GET "https://api.uptizm.com/v1/me" \
  -H "Authorization: Bearer $UPTIZM_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.uptizm.com/v1/me', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.UPTIZM_API_KEY}`,
    'Accept': 'application/json',
  },
});

const data = await response.json();

<?php

$curl = curl_init('https://api.uptizm.com/v1/me');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('UPTIZM_API_KEY'),
        'Accept: application/json',
    ],
]);

$response = curl_exec($curl);

import os

import requests

response = requests.get(
    "https://api.uptizm.com/v1/me",
    headers={
        "Authorization": "Bearer " + os.environ["UPTIZM_API_KEY"],
        "Accept": "application/json",
    },
)

print(response.json())

Try it

API key