Giới thiệu - Kavio Docs

URL cơ sở

API Kavio có tại địa chỉ:

https://app.getkavio.app/api

Xác thực

Mọi yêu cầu API đều cần Bearer token trong header Authorization. Bạn có thể tạo khóa API (Personal Access Token) trên bảng điều khiển Kavio hoặc qua endpoint POST /api-keys.

Authorization: Bearer YOUR_API_KEY

Giữ kín khóa API. Không để khóa xuất hiện trong mã phía máy khách hoặc kho mã công khai. Token dạng văn bản thuần chỉ hiển thị một lần khi tạo, vì vậy hãy lưu ngay.

Phạm vi không gian làm việc

Mỗi khóa API được gắn với một không gian làm việc ngay khi tạo. Mọi yêu cầu đều thao tác trong không gian đó; bạn không thể dùng cùng khóa để xem hoặc sửa tài nguyên ở nơi khác. Nếu làm việc với nhiều không gian, hãy tạo một khóa API cho từng nơi. Bạn có thể dùng cùng khóa cho REST API và máy chủ MCP.

Giới hạn tần suất

Các yêu cầu API được giới hạn tần suất để ngăn hành vi lạm dụng. Khi vượt giới hạn, API trả về mã 429; header Retry-After cho biết cần chờ bao nhiêu giây.

Lỗi

API sử dụng các mã trạng thái HTTP thông dụng. Mọi phản hồi lỗi đều có trường message.

Trạng thái	Mô tả
`200`	Thành công
`201`	Đã tạo
`204`	Không có nội dung (đã xóa thành công)
`401`	Thiếu khóa API hoặc khóa không hợp lệ
`402`	Cần có gói đăng ký đang hoạt động
`404`	Không tìm thấy tài nguyên hoặc tài nguyên nằm ngoài không gian của khóa
`422`	Lỗi xác thực dữ liệu
`429`	Đã vượt giới hạn tần suất

{
  "message": "The name field is required."
}

Cấu trúc phản hồi

Tài nguyên được trả về trực tiếp, không bọc trong data:. Một tài nguyên có dạng:

{
  "id": "9f1a2b3c-...",
  "name": "...",
  "...": "..."
}

Danh sách không phân trang được trả về dưới dạng mảng thuần:

[
  { "id": "9f1a2b3c-...", "name": "..." },
  { "id": "a1b2c3d4-...", "name": "..." }
]

Chỉ endpoint GET /posts bọc dữ liệu trong data: vì endpoint này có phân trang.

Phân trang

Endpoint GET /posts trả về 15 bài đăng mỗi trang. Phản hồi sử dụng cấu trúc phân trang tiêu chuẩn của Laravel:

{
  "data": [...],
  "links": {
    "first": "https://app.getkavio.app/api/posts?page=1",
    "last":  "https://app.getkavio.app/api/posts?page=5",
    "prev":  null,
    "next":  "https://app.getkavio.app/api/posts?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 15,
    "last_page": 5,
    "per_page": 15,
    "total": 72,
    "path": "https://app.getkavio.app/api/posts",
    "links": [
      { "url": null, "label": "&laquo; Previous", "page": null, "active": false },
      { "url": "https://app.getkavio.app/api/posts?page=1", "label": "1", "page": 1, "active": true },
      { "url": null, "label": "Next &raquo;", "page": null, "active": false }
    ]
  }
}

Dùng tham số truy vấn page để chuyển trang. Các endpoint danh sách khác (chữ ký, nhãn, tài khoản mạng xã hội và khóa API) trả về toàn bộ mục trong một mảng thuần, không phân trang.

Tra cứu nhanh

Tài nguyên	Endpoint
Bài đăng	`GET /posts`, `POST /posts`, `GET /posts/{id}`, `PUT /posts/{id}`, `DELETE /posts/{id}`, `POST /posts/{id}/media`, `POST /posts/{id}/media/from-url`, `GET /posts/{id}/metrics`, `GET /posts/{id}/preview`
Nền tảng	`GET /content-types`
Không gian làm việc	`GET /workspace`
Chữ ký	`GET /signatures`, `POST /signatures`, `PUT /signatures/{id}`, `DELETE /signatures/{id}`
Nhãn	`GET /labels`, `POST /labels`, `PUT /labels/{id}`, `DELETE /labels/{id}`
Tài khoản mạng xã hội	`GET /social-accounts`, `PUT /social-accounts/{id}/toggle`
Khóa API	`GET /api-keys`, `POST /api-keys`, `DELETE /api-keys/{id}`

​URL cơ sở

​Xác thực

​Phạm vi không gian làm việc

​Giới hạn tần suất

​Lỗi

​Cấu trúc phản hồi

​Phân trang

​Tra cứu nhanh

URL cơ sở

Xác thực

Phạm vi không gian làm việc

Giới hạn tần suất

Lỗi

Cấu trúc phản hồi

Phân trang

Tra cứu nhanh