JsonApi
Menu

Find endpoints by method, path, function group or authentication mechanism.

Base path

/api/v1

Content type application/json Base URL The public address is configured in Platform Settings.
1

Public Base URL

Copy

Authenticate with API key
2

X-API-Key

Open API Keys Sign in and open.

  1. Settings → API Keys Generate keys Give it a name, choose the minimum scope needed and an expiration date if applicable..
  2. Save secret Copy the secret as soon as it is issued. The system does not display this value again.
  3. cURL Copy
curl "/api/v1/resources" \ -H "X-API-Key: <api-key>" \ -H "Accept: application/json" 
curl "/api/v1/resources" \
  -H "X-API-Key: <api-key>" \
  -H "Accept: application/json"
3

Open Parameters to see the position and required level of each parameter.

Find endpoints

endpoints

89 endpoints

GET
Operations

User-scoped request volume, reliability, latency and endpoint breakdown.

Auth usage:read
Parameters 1
Query Optional

Optional query value; omit it to use the server default.

GET
Platform

Kiểm tra metadata và trạng thái dịch vụ.

Auth Public
POST
Authentication

Tạo tài khoản và phiên đăng nhập đầu tiên.

Auth Public
Parameters 1
JSON body Required

Request payload documented by this operation.

POST
Authentication

Đăng nhập và nhận access token cùng refresh token.

Auth Public
Parameters 1
JSON body Required

Request payload documented by this operation.

POST
Authentication

Đổi refresh token lấy cặp token mới.

Auth Public
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Authentication

Đọc thông tin principal hiện tại.

Auth JWT hoặc API key
POST
Resources

Tạo JSON resource.

Auth resource:write
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Resources

Liệt kê resource bằng cursor, filter và projection.

Auth resource:read
Parameters 8
Query Optional

Cursor returned by the previous page.

Query Optional

Number of resources to return.

Query Optional

Only return resources in this collection.

Query Optional

Filter resources whose name contains this value.

Query Optional

Filter by private or public visibility.

Query Optional

Sort field and direction.

Query Optional

Comma-separated response projection.

Query Optional

Set false to disable extras embedding.

GET
Resources

Đọc resource public hoặc resource thuộc principal.

Auth Public hoặc resource:read
Parameters 1
Path Required

Identifier used in the endpoint path.

PUT
Resources

Cập nhật resource bằng optimistic version.

Auth resource:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

PUT
Resources

Chuyển ownership sang workspace hoặc cá nhân.

Auth resource:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

DELETE
Resources

Xóa resource và dữ liệu phụ trợ.

Auth resource:write
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Resources

Liệt kê version đã nén của resource.

Auth resource:read
Parameters 1
Path Required

Identifier used in the endpoint path.

DELETE
Resources

Xóa lịch sử version.

Auth resource:write
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Resources

Dựng lại score index từ nguồn dữ liệu chính.

Auth resource:write
GET
Resources

Tìm kiếm full-text và query JSON có giới hạn.

Auth search:read
Parameters 4
Query Optional

Full-text search expression.

Query Optional

JSON filter expression.

Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of matches to return.

POST
Bulk jobs

Gửi batch atomic hoặc partial có idempotency.

Auth resource:write
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Bulk jobs

Đọc kết quả batch đồng bộ hoặc bất đồng bộ.

Auth resource:read
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Bulk jobs

Theo dõi tiến độ import, export hoặc bulk job.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

DELETE
Bulk jobs

Yêu cầu hủy job chưa kết thúc.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Collections

Tạo collection với JSON Schema và extras.

Auth collection:write
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Collections

Liệt kê collection của principal.

Auth collection:read
GET
Collections

Đọc một collection.

Auth collection:read
Parameters 1
Path Required

Identifier used in the endpoint path.

PUT
Collections

Cập nhật schema và extras.

Auth collection:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

DELETE
Collections

Xóa collection và bỏ liên kết resource.

Auth collection:write
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Workspaces

Tạo workspace.

Auth workspace:write
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Workspaces

Liệt kê workspace của principal.

Auth workspace:read
GET
Workspaces

Đọc chi tiết workspace.

Auth workspace:read
Parameters 1
Path Required

Identifier used in the endpoint path.

PUT
Workspaces

Cập nhật tên hoặc slug workspace.

Auth workspace:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

DELETE
Workspaces

Xóa workspace khi thỏa điều kiện ownership.

Auth workspace:write
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Workspaces

Liệt kê resource của workspace bằng cursor.

Auth workspace:read
Parameters 3
Path Required

Identifier used in the endpoint path.

Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

GET
Workspaces

Liệt kê thành viên.

Auth workspace:read
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Workspaces

Thêm thành viên trực tiếp.

Auth workspace:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

PUT
Workspaces

Đổi vai trò thành viên.

Auth workspace:write
Parameters 3
Path Required

Identifier used in the endpoint path.

Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

DELETE
Workspaces

Xóa thành viên.

Auth workspace:write
Parameters 2
Path Required

Identifier used in the endpoint path.

Path Required

Identifier used in the endpoint path.

POST
Workspaces

Tạo invitation token có thời hạn.

Auth workspace:write
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

GET
Workspaces

Liệt kê invitation đang quản lý.

Auth workspace:write
Parameters 1
Path Required

Identifier used in the endpoint path.

DELETE
Workspaces

Thu hồi invitation.

Auth workspace:write
Parameters 2
Path Required

Identifier used in the endpoint path.

Path Required

Identifier used in the endpoint path.

POST
Workspaces

Chấp nhận invitation token.

Auth workspace:write
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Collaboration

Đọc discussion bằng cursor.

Auth Authenticated
Parameters 3
Path Required

Identifier used in the endpoint path.

Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

POST
Collaboration

Thêm comment và xử lý mention.

Auth Authenticated
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

PUT
Collaboration

Sửa comment thuộc quyền tác giả.

Auth Authenticated
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

DELETE
Collaboration

Xóa mềm comment.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Collaboration

Liệt kê notification bằng cursor.

Auth Authenticated
Parameters 2
Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

GET
Collaboration

Đếm notification chưa đọc.

Auth Authenticated
PUT
Collaboration

Đánh dấu một notification đã đọc.

Auth Authenticated
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

PUT
Collaboration

Đánh dấu toàn bộ notification đã đọc.

Auth Authenticated
POST
Transfers

Upload file JSON, CSV hoặc XML.

Auth Authenticated
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Transfers

Tạo signed download URL ngắn hạn.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Transfers

Tải object bằng signed token.

Auth Signed token
POST
Transfers

Khởi tạo import job.

Auth Authenticated
Parameters 1
JSON body Required

Request payload documented by this operation.

POST
Transfers

Export đồng bộ hoặc đưa vào queue.

Auth Authenticated
Parameters 1
JSON body Required

Request payload documented by this operation.

POST
Webhooks

Tạo webhook và trả secret một lần.

Auth Authenticated
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Webhooks

Liệt kê webhook.

Auth Authenticated
GET
Webhooks

Đọc cấu hình webhook.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

PUT
Webhooks

Cập nhật endpoint và subscriptions.

Auth Authenticated
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

POST
Webhooks

Xoay signing secret.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

DELETE
Webhooks

Xóa webhook.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Webhooks

Đọc delivery history.

Auth Authenticated
Parameters 3
Path Required

Identifier used in the endpoint path.

Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

POST
Webhooks

Replay một delivery thất bại.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Custom domains

Đăng ký custom domain và verification token.

Auth Authenticated
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Custom domains

Liệt kê custom domain.

Auth Authenticated
GET
Custom domains

Đọc DNS và certificate status.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Custom domains

Kiểm tra TXT và CNAME ownership.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

POST
Custom domains

Yêu cầu thử cấp certificate lại.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

DELETE
Custom domains

Thu hồi route và giải phóng domain.

Auth Authenticated
Parameters 1
Path Required

Identifier used in the endpoint path.

GET
Operations

Đọc audit log của actor.

Auth Authenticated
Parameters 2
Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

GET
Operations

Đọc chính sách lưu trữ audit log.

Auth Authenticated
GET
Operations

Đọc audit log trong workspace.

Auth Authenticated
Parameters 3
Path Required

Identifier used in the endpoint path.

Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

GET
Operations

Đọc usage hiện tại theo chu kỳ.

Auth Authenticated
GET
Operations

Đọc usage archive.

Auth Authenticated
GET
Operations

Đọc dashboard summary.

Auth Authenticated
GET
Operations

Mở SSE stream cá nhân hoặc workspace.

Auth Authenticated
GET
Administration

Đọc analytics rollup.

Auth ADMIN
GET
Administration

Liệt kê user.

Auth ADMIN
PUT
Administration

Thay đổi tier user.

Auth ADMIN
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

GET
Administration

Đọc cấu hình tier.

Auth ADMIN
GET
Administration

Đọc mức sử dụng hạ tầng.

Auth ADMIN
GET
Administration

Đọc cấu hình audit log.

Auth ADMIN
PUT
Administration

Cập nhật cấu hình audit log.

Auth ADMIN
Parameters 1
JSON body Required

Request payload documented by this operation.

GET
Administration

Đọc cấu hình public API URL.

Auth ADMIN
PUT
Administration

Cập nhật public API URL.

Auth ADMIN
Parameters 1
JSON body Required

Request payload documented by this operation.

POST
Administration

Tạo tier mới.

Auth ADMIN
Parameters 1
JSON body Required

Request payload documented by this operation.

PUT
Administration

Cập nhật giới hạn tier.

Auth ADMIN
Parameters 2
Path Required

Identifier used in the endpoint path.

JSON body Required

Request payload documented by this operation.

GET
Administration

Đọc usage toàn hệ thống.

Auth ADMIN
GET
Administration

Quan sát job backlog và failure.

Auth ADMIN
GET
Administration

Quan sát webhook failure.

Auth ADMIN
GET
Administration

Đọc audit log toàn hệ thống.

Auth ADMIN
Parameters 2
Query Optional

Cursor returned by the previous page.

Query Optional

Maximum number of records to return.

GET
Administration

Kiểm tra route registry theo host.

Auth ADMIN
Parameters 1
Path Required

Identifier used in the endpoint path.

Conventions

Cursor pagination

Use cursor returned from response instead of large offset.

Optimistic version

Send the current version when updating or deleting a versioned resource.

Idempotency

Send Idempotency-Key for retryable batches.

Rate limits

Read limit, remaining, reset, and Retry-After from the response headers.