إنتقل إلى المحتوى الرئيسي

Developer Quickstart

This guide gets you up and running with the ProBeya API in under 5 minutes. You will create an API token, make your first request, and understand the basics of the tRPC-based API.

Prerequisites​

  • An ProBeya account with Admin or Owner role.
  • A tool for making HTTP requests (curl, Postman, or any HTTP client).
  • Basic familiarity with JSON and REST-like APIs.

Step 1: Create an API Token​

  1. Log into ProBeya and navigate to Settings > API Tokens.
  2. Click + Create Token.
  3. Enter a name for the token (e.g., "Development").
  4. Select the scopes (permissions) the token needs.
  5. Click Create.
  6. Copy the token and store it securely. It will not be shown again.

Step 2: Make Your First Request​

The ProBeya API uses tRPC over HTTP. All requests go through a single endpoint with procedure names.

List Your Workspaces​

curl -X GET "https://acme.probeya.com/api/trpc/workspace.list" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response:

{
  "result": {
    "data": [
      {
        "id": "ws_abc123",
        "name": "Engineering",
        "slug": "engineering",
        "createdAt": "2026-01-15T10:30:00Z"
      }
    ]
  }
}

Create an Item​

curl -X POST "https://acme.probeya.com/api/trpc/item.create" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "boardId": "brd_xyz789",
    "groupId": "grp_abc123",
    "title": "My first API item",
    "fields": {
      "status": "todo",
      "priority": "medium"
    }
  }'

Step 3: Explore the API​

The full API reference is organized by resource:

Using the TypeScript Client​

If you are building a TypeScript application, install the official client:

pnpm add @probeya/api-client
import { createProBeyaClient } from "@probeya/api-client";

const client = createProBeyaClient({
  baseUrl: "https://acme.probeya.com/api/trpc",
  token: "YOUR_API_TOKEN",
});

// List workspaces
const workspaces = await client.workspace.list();

// Create an item
const item = await client.item.create({
  boardId: "brd_xyz789",
  groupId: "grp_abc123",
  title: "Created from TypeScript",
  fields: {
    status: "todo",
  },
});

Rate Limits​

The API enforces rate limits to ensure fair usage:

PlanRate Limit
Free100 requests per minute
Pro1,000 requests per minute
Enterprise10,000 requests per minute

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Next Steps​