Duyệt tài liệu
Tham chiếu API
Quản lý tham chiếu API
Duyệt điểm kết thúc cho tài khoản, phím, hóa đơn và công việc. Mỗi điểm kết nối liệt kê các yêu cầu xác thực và truy cập riêng.
Đọc tài khoản của bạn bằng một API Khóa
Quản lý API Cơ sở URL là https://api.flashdata.dev/v2. Đọc miễn phí trả lại khóa và tài khoản hiện tại IDs và quyền sở hữu. Đặt FLASHDATA_API_KEY trước khi chạy lệnh.
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}" \
'https://api.flashdata.dev/v2/api-access/identity'Mong đợi HTTP 200 về thành công. Kiểm tra dòng xác thực của mỗi điểm cuối: dataApiKey sử dụng X-API-Key; cookieSession sử dụng một phiên chạy duyệt đã ký. Đáp ứng nhận dạng
Tải về đặc điểm của khách hàng OpenAPI. Nó bao gồm các yêu cầu, công việc, tài khoản, API Chìa khóa và hóa đơn.
Truy vấn tham số và mã yêu cầu được ghi vào tài liệu Google và YouTube API giới thiệu.
Bộ kế hoạch xác thực
| Giản đồ | Cần thiết |
|---|---|
dataApiKey |
Khóa FlashData API. Việc truy cập công việc bị hạn chế trong phạm vi mã nguồn. |
cookieSession |
Phiên họp mạng Opaque. Trình duyệt không thể đọc cookie này. |
csrfToken |
apiKey |
agentRegistrationProof | Thỉnh thoảng có một sự tình cờ mang tính mật mã 32- Cơ sở 64url xác minh và yêu cầu chính xác trước khi gửi đi; phục hồi chỉ với cùng bằng chứng và cơ thể. Không phải OAuth làm ơn đi. |
agentSetupCredential | Thiết lập tạm thời chỉ xác nhận trạng thái và chỉ xác nhận sự tạo ra. Không có dữ liệu API Chìa khóa. |
agentHandoffProof | Bằng chứng được dùng để lấy lại chìa khóa sở hữu và thừa nhận cài đặt. Chưa bao giờ gửi đến một truy vấn dữ liệu. |
agentIdentityKey | Bình thường FlashData API Chìa khóa trong bộ cầm quyền, chỉ trên danh tính tác nhân. Các yêu cầu dữ liệu được dùng X-API-Key Thay vào đó. |
Hệ thống
GET/health
Sức khỏe công tác
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Khỏe mạnh
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Đọc bản tóm tắt trạng thái thành phần công
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Tóm tắt trạng thái công cộng
Đầu trang: Cache-Control
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Đọc một yêu cầu cho phép ứng dụng và kết nối nó vào phiên chạy hiện thời
Yêu cầu toàn bộ phiên điều hành. Yêu cầu hết hạn sau 10 phút. Phản ứng không có gì.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
requestId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Đáp ứng
200 Yêu cầu quyền hạn ứng dụng
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu hết hạn, được dùng hoặc bị hạn chế vào phiên chạy khác
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Ứng dụng hoặc từ chối một yêu cầu cho phép ứng dụng
Toàn bộ phiên họp, CSRF và cho phép cần phải có Nguồn gốc. Ăn một lần yêu cầu. Phản ứng không có gì.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
requestId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Đáp ứng
200 Khách hàng đăng ký gọi lại với mã hoặc từ chối, nhà nước và nhà xuất bản
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu xác thực không sẵn sàng; bắt đầu một kết nối mới
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Tạo một phần tạm dừng FlashData tài khoản
Các điều khoản và phiên bản riêng phải phù hợp với gói hợp pháp hiện tại được xuất bản.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Đáp ứng
201 Tài khoản được tạo; cần thiết kiểm tra thư điện tử
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tốc độ, sự nhất trí, mẻ đá, hay giới hạn công việc còn chờ vượt quá
Đầu trang: Retry-After
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Tạo một phiên chạy mạng mờ nhạt
Đặt chỉ Htp bảo mật `__Host-fd_session` Bánh quy. Đang đợi tài khoản Nhận một điều hạn chế email_verification Phiên chạy cho bảng điều khiển xác thực. Tài khoản xác nhận hợp lệ nhận được tín dụng thử nghiệm một lần của họ về đăng nhập nếu chưa được cấp phép. Một tài khoản hoạt động Nhận được một phiên chạy đầy đủ trừ khi nó di trú vẫn cần một Trong trường hợp này, việc chấp nhận hợp pháp hiện tại bị hạn chế. legal_acceptance Phiên họp. Một tài khoản với yêu cầu xoá theo lịch Nhận phiên chạy deletion_recovery bị hạn chế. Tài khoản xóa bỏ là processing/failed/completed, và các tài khoản bị đình chỉ, nhận được 403.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Đáp ứng
200 Đã xác thực
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Đăng nhập bị cấm; Problem.code là email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, hoặc account_deleted
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Tài khoản tạm thời bị khóa
Đầu trang: Retry-After
Đáp ứng 423 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tốc độ, sự nhất trí, mẻ đá, hay giới hạn công việc còn chờ vượt quá
Đầu trang: Retry-After
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Thu lại phiên chạy hiện thời
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
204 Phiên chạy bị hủy bỏ và đã xoá cookie
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Đọc tài khoản và người dùng hiện thời
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Tài khoản hiện thời
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Lấy CSRF kết nối đến phiên chạy hiện thời
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 CSRF biểu tượng
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Yêu cầu hoặc phục hồi một tin nhắn thư điện tử
Đối với mỗi email hợp lệ, trả lại cùng một phản ứng không kể tài khoản còn thiếu, chờ đợi, hoạt động, đình chỉ hoặc xóa. Các tài khoản chờ đợi bị cấm nhận được một liên kết quay một lần sau khi resend offdown.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Đáp ứng
202 Yêu cầu được chấp nhận. Câu trả lời không cho thấy có một lời tường thuật hay không.
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Yêu cầu xác thực vô danh bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Vượt quá giới hạn xác thực với tỷ lệ vô danh
Đầu trang: Cache-Control, Retry-After, X-Request-Id
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một phụ thuộc xác thực vô danh tạm thời không sẵn sàng
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Kiểm tra một email và kích hoạt tài khoản
Về mặt nguyên tử, tiêu thụ vật chỉ một lần và kích hoạt tài khoản và người dùng. Tài khoản tồn tại và các quy tắc thử nghiệm được áp dụng. Không đăng nhập phiên chạy người dùng rõ ràng. Một yêu cầu cho phép-origin mang các phiên chạy đăng nhập phù hợp với nó X-CSRF-Token có thể nhận được một cookie phiên chạy đã xoay cho cùng tài khoản đã kiểm tra; chỉ một mình người dùng có thể xác nhận một dấu hiệu xác thực.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Đáp ứng
200 Tài khoản đã kích hoạt
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Bảng hiệu một lần không hợp lệ, hết hạn, vô hiệu, đã được sử dụng, hoặc mất một cuộc đua xác nhận đồng thời. Problem.code là `token_unavailable`.
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực vô danh bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Vượt quá giới hạn xác thực với tỷ lệ vô danh
Đầu trang: Cache-Control, Retry-After, X-Request-Id
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một phụ thuộc xác thực vô danh tạm thời không sẵn sàng
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Tiếp tục phiên chạy đăng nhập gốc sau khi xác thực thư điện tử
Cần phải có nguồn gốc và nguồn gốc cho phép CSRF kết nối tới phiên chạy mật khẩu-tự xác thực qua email. Trả lại đang chờ cho đến khi tài khoản phiên chạy của chính nó được kiểm tra, bao gồm cả việc thẩm tra trong một trình duyệt khác. Về mặt nguyên tử, hủy bỏ phiên họp đăng ký và đưa ra một phiên họp toàn phần hoặc hợp pháp mới. Không chấp nhận một tài khoản ID, email, mật khẩu hoặc vật chứng nhận, bỏ qua sự chấp nhận hợp pháp, hoặc cấp vốn.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Đáp ứng
200 Phiên chạy đã đăng nhập
Đầu trang: Set-Cookie, Cache-Control
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 Thư điện tử đang chờ xác thực; không có phiên chạy mới
Đầu trang: Cache-Control
Đáp ứng 202 · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Yêu cầu thư điện tử đặt lại mật khẩu
Luôn luôn trở lại như cũ 202 Trả lời cho một email hợp lệ theo ngữ pháp bất kể tài khoản tồn tại hay trạng thái lặp lại sự sống. Chỉ nhận danh tính được kích hoạt hay bị khóa.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Đáp ứng
202 Yêu cầu được chấp nhận. Câu trả lời không cho thấy có một lời tường thuật hay không.
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Yêu cầu xác thực vô danh bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Vượt quá giới hạn xác thực với tỷ lệ vô danh
Đầu trang: Cache-Control, Retry-After, X-Request-Id
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một phụ thuộc xác thực vô danh tạm thời không sẵn sàng
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Đặt một mật khẩu mới và hủy bỏ các phiên chạy đã có
Về nguyên tử, tiêu thụ biểu tượng mật khẩu, lưu trữ một dấu chấm phẩy kiểu Argon2id mới, thu hồi mỗi phiên chạy đã có, và không hiệu lực các thẻ mật khẩu khác. Nó không đăng nhập người dùng vào hay tạo phiên chạy.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}Đáp ứng
204 Mật khẩu được cập nhật; các phiên chạy đã có bị hủy bỏ
Đầu trang: Cache-Control, X-Request-Id
410 Bảng hiệu một lần không hợp lệ, hết hạn, vô hiệu, đã được sử dụng, hoặc mất một cuộc đua xác nhận đồng thời. Problem.code là `token_unavailable`.
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực vô danh bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Vượt quá giới hạn xác thực với tỷ lệ vô danh
Đầu trang: Cache-Control, Retry-After, X-Request-Id
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một phụ thuộc xác thực vô danh tạm thời không sẵn sàng
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Liệt kê các phiên chạy hoạt động cho người dùng hiện thời
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Phiên chạy
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Thu lại tất cả các phiên chạy ngoại trừ phiên chạy hiện thời
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
204 Các phiên chạy khác bị thu hồi
Đầu trang: Cache-Control, X-Request-Id
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Thu lại một phiên chạy
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
sessionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^ses_"
}Đáp ứng
204 Phiên họp bị hủy bỏ. Nếu nó là phiên chạy hiện thời, cookie sẽ được xoá.
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Kiểm tra mật khẩu hiện thời cho một thao tác nhạy cảm
Ghi lại một bằng chứng ngắn hạn gần đây trong phiên chạy máy chủ bên cạnh.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Đáp ứng
200 Phiên chạy mới
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tốc độ, sự nhất trí, mẻ đá, hay giới hạn công việc còn chờ vượt quá
Đầu trang: Retry-After
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Thay đổi mật khẩu và xoay phiên chạy hiện thời
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"currentPassword",
"newPassword"
],
"properties": {
"currentPassword": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"newPassword": {
"$ref": "#/components/schemas/Password"
},
"revokeOtherSessions": {
"type": "boolean",
"default": true
}
}
}Đáp ứng
204 Mật khẩu đã thay đổi; phiên chạy hiện thời xoay và các phiên chạy khác bị thu hồi khi yêu cầu
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Tài khoản
GET/oauth/connections
Liệt kê các ứng dụng kết nối tài khoản hiện thời
Yêu cầu toàn bộ phiên điều hành. Trống khi tài khoản không có ứng dụng kết nối. Phản ứng không có gì.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Connected apps
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Thu hồi một ứng dụng đã kết nối và sự cống hiến của nó API Khóa
Toàn bộ phiên họp, CSRF và cho phép cần phải có Nguồn gốc. Quyền sở hữu tài khoản được thực thi. Phản ứng không có gì.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
grantId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Đáp ứng
204 Comment
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Đọc thiết lập tài khoản
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Tài khoản
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Cập nhật thiết lập hồ sơ
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Đáp ứng
200 Tài khoản đã cập nhật
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Xóa tài khoản kế hoạch và thu hồi tất cả các phiên chạy đã có và API Keys
Các tài khoản quản trị phải được thu hồi vai trò của họ thông qua dòng công việc kiểm toán trước khi có thể bị xóa sổ. Một yêu cầu xóa bỏ hoạt động độc nhất vô nhị là giới hạn nhận thức tự nhiên. Thời gian biểu xác thực hiện thời trả lại cùng một yêu cầu. Sau khi phiên chạy bị hủy bỏ, việc đăng nhập vào đã được hồi phục deletion_recovery Chế độ và Đọc GET /account/deletion; phiên chạy bị hủy bỏ không bao giờ được chấp nhận để xem lại.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}Đáp ứng
202 Lịch xoá; các phiên chạy hoạt động và phím bị hủy bỏ
Đáp ứng 202 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Đọc yêu cầu xoá tài khoản hiện thời
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Yêu cầu xoá hiện thời
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Hủy bỏ kế hoạch xoá bỏ trong thời gian ân sủng
Sử dụng một cuộc so sánh có lịch để phân loại. Name 409; sau khi thành công phiên chạy phục hồi được xoay và không thể tua lại quá trình chuyển đổi cũ.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
204 Việc xóa bỏ bị hủy bỏ, tài khoản được kích hoạt lại, và khôi phục phiên chạy xoay tùy theo cổng chấp nhận hợp pháp
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept phiên bản được xuất bản hiện tại
Chấp nhận hợp pháp một cách không thay đổi, xóa sổ cổng di trú và quay phiên họp. Phiên bản gửi đi bị từ chối.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Đáp ứng
200 Chấp nhận hợp pháp được ghi lại và phiên chạy quay tới chế độ đầy đủ
Đầu trang: Set-Cookie, Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Đang trên máy bay
GET/onboarding
Đọc tiến trình lên tàu có thể tái sử dụng
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Trạng thái trên tàu hiện tại
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Xác thực cần thiết hay không hợp lệ
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một hồ sơ phụ thuộc cần thiết hoặc lên máy bay là tạm thời không có
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Tiến lên tàu mà không cho phép tiến bộ để di chuyển trở lại
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Đáp ứng
200 Đã cập nhật trạng thái lên máy bay
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Xác thực cần thiết hay không hợp lệ
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một hồ sơ phụ thuộc cần thiết hoặc lên máy bay là tạm thời không có
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Tổng quan
GET/overview
Đọc toàn bộ bảng tài khoản
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Kính hiển thị tài khoản
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Xác thực cần thiết hay không hợp lệ
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một hồ sơ phụ thuộc cần thiết hoặc lên máy bay là tạm thời không có
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Kiểm tra & hiện thời API Sự sở hữu và sự sẵn sàng tái diễn
Chỉ đầu tự do API- Tự đọc đi. Trở lại công khai account/key IDs và quyền sở hữu. Không có xác. Không thay đổi các điều đã có /api-access Phản ứng siêu dữ liệu. Chia sẻ 120/minute Giới hạn đọc tài khoản. Thất bại khi không thể hoàn tất; không suy luận về quyền sở hữu từ tiền tố, kế hoạch hoặc tình trạng địa phương. Không chấp nhận tham số truy vấn. Phản ứng không bị hư.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Kiểm tra & hiện thời API Sự sở hữu và sự sẵn sàng tái diễn
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Đường API Siêu dữ liệu khoá
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 API Keys mà không có bí mật
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Tạo ra một API Chìa khóa và tiết lộ bí mật của nó một lần
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Đáp ứng
201 Tạo ra; cùng một đặc điểm hoàn hảo có thể trả lời được mã hóa tương tự trong năm phút
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Thu hồi lại một khóa API
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
keyId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^key_"
}Đáp ứng
204 Hoàn nguyên
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Tạo một khoá thay thế và lịch lặp lại phím cũ
Tạo một phím mới và giữ phím cũ hoạt động cho đến khi revokeOldAt. Theo mặc định, sự chồng chéo cuối cùng 24 Giờ hoặc cho đến khi chìa khóa cũ hết hạn, bất cứ điều gì là sớm hơn. Một phong tục revokeOldAt Phải trong tương lai, trong vòng bảy ngày, và không trễ hơn so với chìa khóa cũ.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
keyId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · Tùy chọn
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"revokeOldAt": {
"type": "string",
"format": "date-time",
"description": "Optional old-key revocation time; defaults to 24 hours and cannot exceed seven days or the old key expiry."
}
}
}Đáp ứng
201 Sự thay thế được tạo ra; bí mật trở lại một lần
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Đọc các nguồn được cấp phép cho khóa API đang gọi và nguồn gốc kết quả
Xác thực đầu tiên miễn phí là X-API-Key. Trả lại chỉ được công khai. Tên nguồn và nguồn được cấu hình gốc kho lưu đã ký (null nếu không sẵn sàng). Không có tài khoản ID, chìa khóa IDGiấy chứng nhận bí mật hoặc lưu trữ đã được hoàn lại. Cục bộ MCP Hồi sinh điểm kết thúc này trước khi mọi công cụ phát hiện và gọi, Trong đó có kết quả lưu tạm. Không chấp nhận tham số truy vấn hay xác nhận yêu cầu. Tất cả /api-access Đường cùng 120 yêu cầu mỗi phút cho mỗi máy khách IP và trở về Không có gì riêng tư. Lần theo dấu vết sử dụng cuối cùng vẫn xuất hiện.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Nguồn gốc và nguồn gốc công cộng cho phép
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Quá nhiều tài khoản đọc; thử lại sau cửa sổ giới hạn tỷ lệ
503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kết nối
GET/agent-connections/capabilities
Giao thức phát hiện 2 Sự sẵn có trên tàu
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Giao thức phát hiện 2 Sự sẵn có trên tàu
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Tạo hoặc phục hồi một tạm thời API- Kết nối phím
Đặt chứng minh và nhập chính xác trước POST. Cùng bằng chứng và cơ thể hồi phục cùng một thử nghiệm; thay đổi kết quả dẫn đến xung đột. Thử ra tạm thời: 1 Tín dụng, 72 Giờ, 1 request/secondKích cỡ hàng loạt 1. Giới hạn nguồn vẫn còn trên máy phục vụ. Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentRegistrationProof
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Đáp ứng
201 Tạo hoặc phục hồi một tạm thời API- Kết nối phím
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Liệt kê các kết nối có tên trình duyệt
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân. Thao tác được biết đến bởi trình duyệt. Yêu cầu xác nhận đầy đủ phiên chạy; không thể thay thế phiên chạy API Chìa khóa hoặc bằng chứng.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Liệt kê các kết nối có tên trình duyệt
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Đọc trạng thái kết nối tạm thời
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentSetupCredential
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Đáp ứng
200 Đọc trạng thái kết nối tạm thời
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Thu hồi kết nối đã có
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân. Thao tác được biết đến bởi trình duyệt. Yêu cầu xác nhận đầy đủ phiên chạy; không thể thay thế phiên chạy API Chìa khóa hoặc bằng chứng.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · cần thiết
Schema
{
"type": "string"
}X-CSRF-Token · header · cần thiết
Schema
{
"type": "string"
}Đáp ứng
204 Thu hồi kết nối đã có
400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Kiểm tra dữ liệu hiện thời API phím cho kết nối
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentIdentityKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Đáp ứng
200 Kiểm tra dữ liệu hiện thời API phím cho kết nối
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Đọc có thể phục hồi tình trạng trên tàu
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentHandoffProof
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Đáp ứng
200 Đọc có thể phục hồi tình trạng trên tàu
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Tạo một yêu cầu chấp nhận trình duyệt
Mở claimPath trên một uy tín FlashData Nguồn gốc web và hiển thị mã riêng biệt. Không bao giờ đặt giấy chứng nhận hoặc mã xác nhận trong URL. Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentSetupCredential
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Đáp ứng
201 Tạo một yêu cầu chấp nhận trình duyệt
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Xác nhận mã nhận trong một phiên chạy duyệt đã kiểm tra
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân. Thao tác được biết đến bởi trình duyệt. Yêu cầu xác nhận đầy đủ phiên chạy; không thể thay thế phiên chạy API Chìa khóa hoặc bằng chứng.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
claimId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · cần thiết
Schema
{
"type": "string"
}X-CSRF-Token · header · cần thiết
Schema
{
"type": "string"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Đáp ứng
200 Xác nhận mã nhận trong một phiên chạy duyệt đã kiểm tra
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Đọc một yêu cầu được xác nhận trong phiên chạy duyệt của nó
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân. Thao tác được biết đến bởi trình duyệt. Yêu cầu xác nhận đầy đủ phiên chạy; không thể thay thế phiên chạy API Chìa khóa hoặc bằng chứng.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
claimId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Đáp ứng
200 Đọc một yêu cầu được xác nhận trong phiên chạy duyệt của nó
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Áp dụng giảm phạm vi và ngân sách số dư tài khoản
Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân. Thao tác được biết đến bởi trình duyệt. Yêu cầu xác nhận đầy đủ phiên chạy; không thể thay thế phiên chạy API Chìa khóa hoặc bằng chứng.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
claimId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · cần thiết
Schema
{
"type": "string"
}X-CSRF-Token · header · cần thiết
Schema
{
"type": "string"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Đáp ứng
200 Áp dụng giảm phạm vi và ngân sách số dư tài khoản
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"status",
"expiresAt"
]
}
},
"required": [
"connection",
"handoff"
]
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Phục hồi lại chủ sở hữu đã được chấp thuận API Khóa
Comment 24 giờ cho đến khi cài đặt ACK. Theo nguyên tử, nạp lại trong một quá trình mới và xác nhận danh tính trước ACK. Nhiều lần người giao hàng phục hồi được cùng một ứng cử viên; xác nhận việc giao hàng đã trả lại hóa đơn mà không có giấy ủy quyền. Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentHandoffProof
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Đáp ứng
200 Phục hồi lại chủ sở hữu đã được chấp thuận API Khóa
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Xác nhận đã xác nhận cài đặt phím nóng cho người sở hữu
Người gọi chắc đã cứu được ứng cử viên và độc lập xác nhận nó trong một quá trình mới. ACK mark thành công được cài đặt, loại bỏ chìa khóa của ứng cử viên và xoá bỏ tài liệu có thể nhận lại được. Nhắc lại, ACK là người bình thường. Không chấp nhận tham số truy vấn. Phản ứng không bị hư. Các tuyến đường tác nhân chỉ có quản lý và quản lý tính năng; các cuộc triển khai có thể trở lại 404 khi bị tắt. X-API-Key bị cấm trên đường tác nhân.
Xác thực: agentHandoffProof
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
connectionId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Đáp ứng
200 Xác nhận đã xác nhận cài đặt phím nóng cho người sở hữu
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Yêu cầu bị từ chối; thanh tra mã vấn đề. Đừng bao giờ thử lại đột biến mù quáng.
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Catalog
GET/catalog/sources
Liệt kê khả năng nguồn công cộng không có giá trị tài khoản cụ thể
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Danh mục nguồn công cộng
Đầu trang: Cache-Control
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Liệt kê công cộng USD kế hoạch và giá cả
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Mục lục kế hoạch công cộng
Đầu trang: Cache-Control
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Đọc các điều khoản và phiên bản riêng tư hiện thời cần thiết để ký tên
Xác thực: Chung
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Mục lục phiên bản hợp pháp hiện thời
Đầu trang: Cache-Control
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Đọc tờ giấy dài hạn có hiệu quả
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Đăng ký hay PAYG Quyền lợi
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Tạo một phiên chạy kiểm tra tên tập tin thoát vị
Các gói tín dụng được xuất bản và gửi đi priceId. Name amountMinor thay vào đó (USD Tiền xu, $10 tới $999,999.99; máy phục vụ tính toán tín dụng với giá trị tín dụng cố định và tạo ra giá một lần thoát y tư nhân. Sản phẩm, nhà cung cấp giá, tiền tệ, thành công URL và hủy bỏ URL không bao giờ được chấp nhận từ trình duyệt. Các tài liệu chỉ được cấp sau khi kiểm tra số tiền được trích dẫn.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
},
"purchaseType": {
"type": "string",
"enum": [
"subscription",
"top_up"
],
"default": "subscription"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"amountMinor",
"purchaseType"
],
"properties": {
"amountMinor": {
"type": "integer",
"minimum": 1000,
"maximum": 99999999,
"description": "Custom top-up amount in USD cents."
},
"purchaseType": {
"type": "string",
"const": "top_up"
}
}
}
]
}Đáp ứng
201 Thoát khỏi phiên chạy kiểm tra
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Một nhà cung cấp xuôi dòng thất bại
Đáp ứng 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Danh mục hoặc nhà cung cấp hoá đơn chưa được cấu hình hoặc tạm thời không có
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Nâng cấp giấy tờ sọc hiện thời lên giá cao hơn được xuất bản
Máy phục vụ xác nhận rằng FlashData Giá cả đang hoạt động, có sẵn trong hệ thống dẫn nhiệt hiện tại, USD- ...được phát hiện, tái phát, cùng khoảng thời gian đó, và đắt hơn giá đăng ký hiện tại. Tùy chọn sản phẩm, nhà cung cấp giá, tiền tệ và tiền tệ không bao giờ được chấp nhận từ trình duyệt. Quyền lợi và tín dụng địa phương chỉ thay đổi sau một sự kiện cung cấp đã được kiểm chứng.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Đáp ứng
201 Gửi thay đổi dưới đây tới Dải
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Một nhà cung cấp xuôi dòng thất bại
Đáp ứng 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Danh mục hoặc nhà cung cấp hoá đơn chưa được cấu hình hoặc tạm thời không có
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Tạo một cổng tự chọn sọc
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Đáp ứng
201 Gỡ bỏ phiên chạy cổng tự chọn
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Một nhà cung cấp xuôi dòng thất bại
Đáp ứng 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Danh mục hoặc nhà cung cấp hoá đơn chưa được cấu hình hoặc tạm thời không có
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Lịch hoặc hủy bỏ kế hoạch đăng ký hiện thời
Thiết lập cancelAtPeriodEnd phải true Lịch hủy bỏ tại thời gian hóa đơn hiện tại; false giữ lại giấy đăng ký. Cập nhật danh sách sau một sự kiện đã được xác nhận là "Trích dẫn" Điểm kết thúc này không bao giờ hủy bỏ ngay lập tức hoặc đưa ra một khoản tiền hoàn lại.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Đáp ứng
202 Hủy cập nhật đã gửi cho Strie
Đáp ứng 202 · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Một nhà cung cấp xuôi dòng thất bại
Đáp ứng 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Danh mục hoặc nhà cung cấp hoá đơn chưa được cấu hình hoặc tạm thời không có
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Liệt kê các dự án hoá đơn sọc
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
cursor · query · Tùy chọn
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Tùy chọn
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Đáp ứng
200 Hóa đơn
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Liệt kê các bản sao chép tài khoản lên cao và hoàn trả các bản chiếu thanh toán
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
cursor · query · Tùy chọn
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Tùy chọn
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Đáp ứng
200 Một lần trả tiền lịch sử mà không có bí mật của nhà cung cấp
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Tín dụng
GET/api-access/balance
Đọc phần bổ sung tài khoản trực tiếp bằng cách sử dụng một API Khóa
Đọc sự số dư tín dụng hiện tại được chia sẻ bởi tất cả API chìa khóa trong tài khoản của anh. Việc đặt chỗ trước tích cực có thể làm giảm sự số dư sẵn có. Yêu cầu này không mất tín hiệu và không lấy tham số truy vấn hay cơ thể. Đáp ứng là riêng tư và không được lưu tạm; giới hạn đọc tài khoản.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Số tiền được ký và không âm tính có sẵn
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Quá nhiều tài khoản đọc; thử lại sau cửa sổ giới hạn tỷ lệ
503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Đọc giá thực tế tài khoản cho nguồn thông tin được ủy quyền bởi API Khóa
Đọc tỷ lệ tài khoản của bạn cho các nguồn cho phép bởi API Chìa khóa. A null giá cả nghĩa là nguồn tin đó không có sẵn. request_count tỷ lệ tải về là mỗi lần mắc bệnh lao (không có vật dụng trả về).10^12 byte). Số phỏng đoán không lưu trữ tín dụng hay khả năng. Yêu cầu này không tốn tiền tín dụng. Đáp ứng là riêng tư và không được lưu tạm; giới hạn đọc tài khoản.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
source · query · Tùy chọn
Một nguồn được cấp cho chìa khóa này; bỏ qua việc đọc tất cả các nguồn được cho phép.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · Tùy chọn
Số nguyên thập phân của cuộc gọi; không ước tính kích cỡ tải về.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Đáp ứng
200 Kế hoạch tài khoản và giá cả cụ thể nguồn
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Quá nhiều tài khoản đọc; thử lại sau cửa sổ giới hạn tỷ lệ
503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Đọc giới hạn về kế hoạch tài khoản và công việc đang chờ hiện thời bằng một API Khóa
Hãy đọc những giới hạn về sự nhất trí, kích thước hàng loạt và công việc đang chờ đợi, cộng với số lượng hiện tại. Những giá trị này giúp lập kế hoạch yêu cầu nhưng không có khả năng dự trữ. Yêu cầu này không mất tín hiệu và không lấy tham số truy vấn hay cơ thể. Đáp ứng là riêng tư và không được lưu tạm; giới hạn đọc tài khoản.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Lên kế hoạch trần nhà và đếm hiện tại
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Quá nhiều tài khoản đọc; thử lại sau cửa sổ giới hạn tỷ lệ
503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Đọc cách sử dụng tài khoản cho các nguồn do các API Khóa
Đọc miễn phí, xác thực chỉ bởi X-API-Key. Gồm tất cả các phím tài khoản, nhưng Chỉ có những nguồn tin được cấp chìa khóa. Không trả lời đoạn truy vấn, phím, thanh toán chi tiết hoặc các tài khoản khác. Mặc định là bảy ngày; tối đa là ngày 31. Ngày tháng phải dùng nhãn thời gian UTC Z. Từ là vô tận và độc quyền; Cả hai đều bị bao vây từng phút. Với từ cô đơn, mặc định đến từ + 7 ngày. Với cả hai, đây là khởi đầu của phút tiếp theo. Rốt cuộc thì sự phân biệt chủng tộc là nhất quán, thậm chí cập nhật =false không đảm bảo rằng tất cả các sự kiện gần đây đều bị nuốt chửng. Giới hạn đọc: Yêu cầu 60 mỗi phút cho khách hàng IP.
Xác thực: dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
source · query · Tùy chọn
Một nguồn danh mục chính xác được cấp cho chìa khóa gọi; bỏ qua có nghĩa là tất cả các nguồn được cho phép.
Schema
{
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}from · query · Tùy chọn
Schema
{
"type": "string",
"format": "date-time"
}to · query · Tùy chọn
Schema
{
"type": "string",
"format": "date-time"
}Đáp ứng
200 Yêu cầu được lật đổ tính và tính tiền, với thông tin mới
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Quá nhiều cách sử dụng đọc; thử lại sau cửa sổ giới hạn tốc độ
503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Đọc các công cụ hiện có và dành riêng cho người dùng
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Số dư tín dụng
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Đọc chính sách ghi sổ tín dụng và tính tiền hữu hiệu
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Chính sách tín dụng hiệu quả
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Liệt kê mục ghi chép tín dụng
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
cursor · query · Tùy chọn
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Tùy chọn
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · Tùy chọn
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Đáp ứng
200 Mục nhập Sổ cái
Đáp ứng 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Nguồn tư liệu thử thách
GET/trial-credit-request
Đọc giấy tờ xét xử và yêu cầu cuộc đời tài khoản.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Khả năng cao hiện tại, tài trợ đã cấu hình và yêu cầu tình trạng
Đầu trang: Cache-Control
Đáp ứng 200 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Xác thực cần thiết hay không hợp lệ
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một hồ sơ phụ thuộc cần thiết hoặc lên máy bay là tạm thời không có
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Gửi cho tài khoản một lần trong đời yêu cầu xét xử tín dụng
Số tiền thử nghiệm và sử dụng được lưu lại khi bạn đệ trình yêu cầu.
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Idempotency-Key · header · cần thiết
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yêu cầu xác chết · Tùy chọn
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Đáp ứng
201 Yêu cầu tín dụng Trial được tạo ra và tự động phê chuẩn cho các tài khoản đã xác nhận đủ tiêu chuẩn, bất kể nhà cung cấp thư điện tử
Đầu trang: Cache-Control
Đáp ứng 201 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Xác thực cần thiết hay không hợp lệ
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Xác thực nhưng không được phép, hay CSRF việc hợp lệ hoá bị lỗi
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Name
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một hồ sơ phụ thuộc cần thiết hoặc lên máy bay là tạm thời không có
Đầu trang: Cache-Control, X-Request-Id
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Giao hàng
GET/delivery/webhooks
Danh sách các cuộc gọi đầy đủ đã lưu URLs
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Đáp ứng
200 Gọi lại URLs
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Lưu cú gọi lại hoàn chỉnh URL
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Đáp ứng
201 Tạo
Đáp ứng 201 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Gỡ bỏ vòng gọi hoàn chỉnh URL
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
webhookId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Đáp ứng
204 Bỏ
401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Gửi mẫu tải về đầy đủ
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
webhookId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Đáp ứng
200 Thử ra
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Công việc
Để phục tùng, trong hoàn cảnh và kết quả các ví dụ, xem Realtime và mộtsync · Yêu cầu theo lô.
GET/jobs
Danh sách API công việc cho vùng làm việc hiện thời
Đã tưởng tượng ra lịch sử hoạt động và lưu trữ. Mặc định trong bảy ngày qua; mỗi phạm vi ngày tháng UTC chỉ giới hạn 31 ngày. Từ bao gồm và đến là độc quyền, chính xác trong phút chốc. Các tế bào tổng thể được giữ kín và có thể ăn chậm.
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
cursor · query · Tùy chọn
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · Tùy chọn
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · Tùy chọn
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · Tùy chọn
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · Tùy chọn
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · Tùy chọn
Schema
{
"type": "string",
"format": "date-time"
}to · query · Tùy chọn
Schema
{
"type": "string",
"format": "date-time"
}Đáp ứng
200 Trang công việc
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"summary"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"summary": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"completed",
"credits",
"failed",
"total"
],
"properties": {
"completed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"updating": {
"type": "boolean"
}
}
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Đọc một dữ liệu API công việc
Đọc job.status để kiểm tra tiến trình và job.error nếu quá trình xử lý bị lỗi. JSON là mặc định; sử dụng Accept: text/plain cho văn bản dễ đọc. X-Respond-With bị bỏ qua ở đây. Theo Retry-After khi được cung cấp trước khi kiểm tra lại.
Xác thực: cookieSession hay dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
Accept · header · Tùy chọn
application/json trả lại câu trả lời có cấu trúc ban đầu; text/plain trả lại cùng một lĩnh vực như indented văn bản đồng bằng. Các phạm vi phương tiện tiêu chuẩn và q được hỗ trợ; còn thiếu Accept hoặc một ký tự đại diện cho toàn cục JSON. X-Respond-With bị bỏ qua khi nộp và làm việc. Lỗi vẫn còn được cấu trúc JSON. Cả hai kiểu ứng dụng đều được dùng UTF-8; một ký tự rõ ràng =utf-8 hỗ trợ tham số.
Schema
{
"type": "string"
}jobId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Đáp ứng
200 Chi tiết công việc
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}Đáp ứng 200 · text/plain
{
"type": "string"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Cả hai application/json cũng không text/plain được chấp nhận; phản ứng là JSON
Đáp ứng 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Tải về kết quả đã có
Theo mặc định, xác thực quyền truy cập rồi chuyển hướng đến URL R2 riêng tư có thời hạn ngắn; trình khách nhận JSON gốc trực tiếp từ R2. Accept: text/plain trả về HTTP 200 độc lập với các trường kết quả gốc dưới dạng văn bản thụt lề. X-Respond-With: markdown chọn nội dung Markdown: application/json đặt nội dung trong content cùng siêu dữ liệu gốc, thay cho results; text/plain trả về siêu dữ liệu rồi đến Markdown. Nếu thiếu Accept hoặc dùng ký tự đại diện toàn cục, định dạng mặc định là JSON. Định dạng lại không gửi truy vấn mới và không tính thêm tín dụng truy vấn. Kết quả lưu trữ hết hạn sau 24 giờ kể từ khi hoàn tất. Lỗi vẫn là JSON có cấu trúc.
Xác thực: cookieSession hay dataApiKey
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
X-Respond-With · header · Tùy chọn
Đặt đánh dấu để trả lại nội dung kết quả như Markdown. Omit giữ lại các trường kết quả ban đầu. Accept Chọn riêng JSON hoặc chỉ đơn giản là văn bản. Chỉ có những yêu cầu thời gian thực và hoàn tất công việc kết quả đọc hỗ trợ đầu đề này. Nó không thay đổi việc nộp đơn, tình trạng, tài khoản APIs, gọi lại, Bulk Tập tin, tải về nhị phân, hoặc MCP Phản ứng giao thức.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · Tùy chọn
Chọn application/json hay text/plain Độc lập X-Respond-With. Không có X-Respond-With, text/plain trả lại các lĩnh vực ban đầu với indentation; JSON giữ lại các trường phản ứng gốc (đã hoàn tất-sulk đọc chuyển hướng đến lưu trữ). Với đánh dấu xuống, JSON trả về nội dung cộng với siêu dữ liệu và văn bản đơn giản trả về Markdown. Các phạm vi phương tiện tiêu chuẩn và q được hỗ trợ; còn thiếu Accept hoặc một ký tự đại diện cho toàn cục JSON. Cả hai kiểu ứng dụng đều được dùng UTF-8; một ký tự rõ ràng =utf-8 hỗ trợ tham số.
Schema
{
"type": "string"
}jobId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Đáp ứng
200 Các trường gốc thô hoặc Markdown trở về trực tiếp; gốc JSON từ R2 sau khi theo bộ chuyển tiếp mặc định
Đáp ứng 200 · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}Đáp ứng 200 · text/plain
{
"type": "string"
}302 Chuyển đổi sang tác vụ gốc JSON trong riêng R2 cất giữ khi JSON được chọn mà không có X-Respond-With
Đầu trang: Location
400 Không hỗ trợ X-Respond-With giá trị; câu trả lời là JSON
Đáp ứng 400 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Cả hai application/json cũng không text/plain được chấp nhận; phản ứng là JSON
Đáp ứng 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Kết quả hết hạn
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Tác vụ thất bại. Nếu nguyên nhân đã được lưu, trường detail của phản hồi sẽ chứa nguyên nhân đó.
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API xử lý Bulk
Bulk Điểm cuối có một tham chiếu tận tâm với các tham số, yêu cầu ví dụ và câu trả lời. Mở Bulk xử lý API
GET /v2/bulk-jobs· Danh sách phần lớn YouTube công việcPOST /v2/bulk-jobs· Tạo một Bulk công việc và tải lên tập tin URLGET /v2/bulk-jobs/{bulkId}· Đọc tiến trình công việc quá tải và tổng hợp đếmPATCH /v2/bulk-jobs/{bulkId}· Thay đổi thiết lập cho ảnh chưa khởi chạyDELETE /v2/bulk-jobs/{bulkId}· Hủy bỏ a Bulk công việcPOST /v2/bulk-jobs/{bulkId}/start· Bắt đầu quét một bản tải lên YouTube ID Tập tinPOST /v2/bulk-jobs/{bulkId}/pause· Tạm dừng Bulk công việcPOST /v2/bulk-jobs/{bulkId}/resume· Tiếp tục một công việc to lớn bằng tay hay tự động dừng lạiGET /v2/bulk-jobs/{bulkId}/results· Tải về bảng chọnGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Tải về một gzip-com nén NDJSON phần kết quả lớn
Vùng chơi
POST/playground/run
Chạy một truy vấn sân chơi như là không gian làm việc hiện tại
Xác thực: cookieSession + csrfToken
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Yêu cầu xác chết · cần thiết
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"source",
"mode",
"query"
],
"properties": {
"source": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
},
"query": {
"description": "Source request body. In batch mode, also accepts an object containing only queries, an array of 1 to 20 request bodies. Every entry must match the selected source and its input schema. Search and Suggestions require query; Channel requires handle; Metadata, Transcript, Captions, Trainability and Download require an 11-character video_id matching [A-Za-z0-9_-]. Download batch entries must supply params.storage for customer storage; console browser delivery is not supported in this envelope. Account batch and pending-job limits still apply.",
"type": "object",
"additionalProperties": true
}
}
}Đáp ứng
200 Dữ liệu xuôi dòng API Phản ứng được ghi lại ở sân chơi
Đáp ứng 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"body",
"endpoint",
"mode",
"status"
],
"properties": {
"body": {},
"endpoint": {
"type": "string",
"enum": [
"/v1/queries",
"/v1/queries/batch",
"/v1/queries/realtime"
]
},
"mode": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Yêu cầu xác thực thất bại
Đáp ứng 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Tải về một tác phẩm hiện thời được hoàn tất trên trình duyệt
Xác thực: cookieSession
Máy phục vụ: https://api.flashdata.dev/v2
Máy phục vụ: http://localhost:5000/v2
Tham số
jobId · path · cần thiết
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Đáp ứng
200 Comment
Đầu trang: Content-Disposition, Content-Length
Đáp ứng 200 · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Xác thực cần thiết hay không hợp lệ
Đáp ứng 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Không tìm thấy tài nguyên hay không thuộc về người gọi
Đáp ứng 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Tình trạng tài nguyên hoặc xung đột quyền tối thiểu
Đáp ứng 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Hiện vật tạm thời đã hết hạn
Đáp ứng 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Một quan hệ phụ thuộc hay danh mục cần thiết tạm thời không tồn tại
Đáp ứng 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Định nghĩa sơ đồ
APIKeyIdentity
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKeyId": {
"type": "string"
},
"accountId": {
"type": "string"
},
"accountType": {
"type": "string",
"enum": [
"owned",
"temporary"
]
},
"ownership": {
"type": "string",
"enum": [
"owned",
"unowned"
]
},
"access": {
"type": "string",
"enum": [
"ready",
"blocked"
]
},
"installed": {
"type": "boolean"
},
"recurringAllowed": {
"type": "boolean"
},
"connectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"verifiedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"apiKeyId",
"accountId",
"accountType",
"ownership",
"access",
"installed",
"recurringAllowed",
"connectionId",
"scopes",
"expiresAt",
"verifiedAt"
],
"description": "Authoritative current-record ownership and readiness. Public IDs only. recurringAllowed requires a verified active owner and, for agent-issued keys, server-confirmed installation. It is a point-in-time check, not an authorization token or permission to reuse cached data after revocation."
}Account
{
"type": "object",
"description": "Deleted accounts are only returned through authorized Admin projections; their identity fields are redacted.",
"additionalProperties": false,
"required": [
"id",
"name",
"email",
"status",
"emailVerified",
"legalAcceptanceRequired",
"role",
"timezone",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^acct_"
},
"name": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
],
"format": "email"
},
"status": {
"type": "string",
"enum": [
"pending_verification",
"active",
"suspended",
"deleting",
"deleted"
]
},
"emailVerified": {
"type": "boolean"
},
"legalAcceptanceRequired": {
"type": "boolean"
},
"role": {
"type": "string",
"enum": [
"user",
"admin"
]
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}AccountDeletionRequest
{
"type": "object",
"description": "User-safe deletion summary. Durable processor cursor and per-step metadata are internal operational state and are intentionally omitted.",
"additionalProperties": false,
"required": [
"id",
"status",
"requestedAt",
"scheduledFor",
"cancellable",
"billingCancellationStatus",
"activeJobsAtRequest",
"retryable"
],
"properties": {
"id": {
"type": "string",
"pattern": "^del_"
},
"status": {
"type": "string",
"enum": [
"scheduled",
"cancelled",
"processing",
"completed",
"failed"
]
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"scheduledFor": {
"type": "string",
"format": "date-time"
},
"cancellable": {
"type": "boolean"
},
"cancelledAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"processingStartedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"failureCode": {
"type": [
"string",
"null"
],
"maxLength": 80
},
"billingCancellationStatus": {
"type": "string",
"enum": [
"not_required",
"pending",
"completed",
"failed"
]
},
"activeJobsAtRequest": {
"type": "integer",
"minimum": 0
},
"retryable": {
"type": "boolean",
"description": "True only when an Admin-audited processor retry is possible; it does not grant the user mutation access."
}
}
}AgentApproval
{
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowAccountBalance": {
"const": true
}
},
"required": [
"scopes",
"allowAccountBalance"
]
}AgentBrowserClaim
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"claimId": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"connection",
"claimId",
"expiresAt"
]
}AgentCapabilities
{
"type": "object",
"additionalProperties": false,
"properties": {
"protocolVersion": {
"const": 2
},
"available": {
"type": "boolean"
},
"flow": {
"const": "temporary_account_api_key"
},
"dataOrigin": {
"type": "string"
},
"queryPath": {
"const": "/v1/queries/realtime"
},
"credentialType": {
"const": "api_key"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPermission"
}
},
"owner": {
"type": "object",
"additionalProperties": false,
"required": [
"scopes"
],
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"trial": {
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"credits": {
"type": "number"
},
"lifetimeHours": {
"type": "integer",
"minimum": 0
},
"requestsPerSecond": {
"type": "integer",
"minimum": 0
},
"maxBatchSize": {
"type": "integer",
"minimum": 0
},
"requestCounts": {}
},
"required": [
"credits",
"lifetimeHours",
"requestsPerSecond",
"maxBatchSize",
"requestCounts"
]
},
"recurringRequires": {
"const": "owned_key_installed"
},
"replayProtection": {
"const": "client_local_only"
}
},
"required": [
"protocolVersion",
"available"
]
}AgentClaim
{
"type": "object",
"additionalProperties": false,
"properties": {
"claimId": {
"type": "string"
},
"claimPath": {
"type": "string"
},
"confirmationCode": {
"type": "string",
"pattern": "^\\d{8}$"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"pollAfterSeconds": {
"type": "integer",
"minimum": 0
}
},
"required": [
"claimId",
"claimPath",
"confirmationCode",
"expiresAt",
"pollAfterSeconds"
]
}AgentClaimView
{
"type": "object",
"additionalProperties": false,
"required": [
"connection"
],
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
}
}
}AgentConnection
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"audience": {
"type": "string",
"enum": [
"coding",
"personal",
"unspecified"
]
},
"ownership": {
"type": "string",
"enum": [
"owned",
"unowned"
]
},
"lifecycle": {
"type": "string",
"enum": [
"valid",
"revoked",
"expired"
]
},
"access": {
"type": "string",
"enum": [
"ready",
"fenced",
"blocked"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Actual scopes on the current API key. May be empty on an unowned claim-only connection; every data-source request is then forbidden."
},
"requestedScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Original owner-access request. Claim approval can only reduce this set. Legacy connections retain their original scopes."
},
"trialScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Saved subset eligible for the temporary key. Never expanded by catalog changes."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPermission"
}
},
"generation": {
"type": "integer",
"minimum": 0
},
"installed": {
"type": "boolean"
},
"trialExpiresAt": {
"type": "string",
"format": "date-time"
},
"fundingMode": {
"type": "string",
"enum": [
"trial",
"account_balance"
]
},
"trialCredits": {
"type": "number"
},
"trialRequestCounts": {}
},
"required": [
"id",
"name",
"audience",
"ownership",
"lifecycle",
"access",
"scopes",
"generation",
"installed",
"trialExpiresAt",
"fundingMode",
"trialCredits",
"trialRequestCounts"
]
}AgentConnectionResponse
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
}
},
"required": [
"connection"
]
}AgentHandoff
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"delivered",
"confirmed"
]
},
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"credentials": {
"$ref": "#/components/schemas/AgentCredentials"
},
"generation": {
"type": "integer",
"minimum": 0
}
},
"required": [
"status"
]
}AgentCredentials
{
"type": "object",
"additionalProperties": false,
"properties": {
"connectionId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"setupCredential": {
"type": "string"
},
"handoffProof": {
"type": "string"
},
"generation": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connectionId",
"apiKey",
"generation"
],
"description": "Sensitive ordinary API-key credentials. Never log or put in browser URLs. Proofs are returned on temporary registration; handoff returns the owned candidate key."
}AgentOnboardingStatus
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"awaiting_claim",
"claim_processing",
"handoff_ready",
"installed",
"handoff_expired",
"expired",
"revoked",
"blocked"
]
},
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"nextAction": {
"type": "string"
},
"pollAfterSeconds": {
"type": "integer",
"minimum": 0
}
},
"required": [
"status"
]
}AgentPermission
{
"type": "object",
"additionalProperties": false,
"required": [
"source",
"name",
"product",
"trialEligible",
"ownerAllowed",
"requiresStorageDestination"
],
"properties": {
"source": {
"type": "string",
"pattern": "^[a-z_]{1,80}$"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
},
"trialEligible": {
"type": "boolean"
},
"ownerAllowed": {
"type": "boolean"
},
"requiresStorageDestination": {
"type": "boolean"
}
},
"description": "Catalog-derived agent permissions. Trial eligibility is an explicit opt-in independent of owner approval. Storage and variable-price sources require owner access."
}AgentRegistration
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"credentials": {
"$ref": "#/components/schemas/AgentCredentials"
},
"dataOrigin": {
"type": "string"
},
"deniedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"limits": {
"type": "object",
"additionalProperties": true
},
"nextAction": {
"type": "string",
"enum": [
"query_or_claim",
"claim"
],
"description": "Claim before the first data request when no requested source is trial eligible."
}
},
"required": [
"connection",
"credentials",
"dataOrigin",
"deniedScopes",
"limits"
]
}AgentRegistrationRequest
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"audience": {
"type": "string",
"enum": [
"coding",
"personal"
]
},
"scopes": {
"type": "array",
"minItems": 1,
"maxItems": 30,
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z_]{1,80}$"
}
},
"client": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
},
"transport": {
"type": "string",
"enum": [
"api",
"cli",
"mcp"
]
}
},
"required": [
"name",
"scopes"
]
}ApiAccess
{
"type": "object",
"additionalProperties": false,
"required": [
"sources",
"result_origin"
],
"properties": {
"sources": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/ApiAccessSource"
}
},
"result_origin": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Configured signed-result storage origin, without credentials, path, query or fragment. Not an access token or a media URL."
}
}
}ApiAccessBalance
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"unit",
"balanceCredits",
"availableCredits",
"updatedAt",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account"
},
"unit": {
"type": "string",
"const": "Credits"
},
"balanceCredits": {
"type": "number",
"description": "Signed live balance; in-flight reservations may already be reflected."
},
"availableCredits": {
"type": "number",
"minimum": 0,
"description": "max(balanceCredits, 0)."
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
}
}
}ApiAccessLimits
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"plan",
"limits",
"current",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account"
},
"plan": {
"$ref": "#/components/schemas/ApiAccessPlan"
},
"limits": {
"type": "object",
"additionalProperties": false,
"properties": {
"concurrency": {
"type": "integer",
"minimum": 0
},
"batchSize": {
"type": "integer",
"minimum": 0
},
"pendingJobs": {
"type": "integer",
"minimum": 0
}
}
},
"current": {
"type": "object",
"additionalProperties": false,
"required": [
"pendingJobs"
],
"properties": {
"pendingJobs": {
"type": "integer",
"minimum": 0
}
}
},
"note": {
"type": "string"
}
}
}ApiAccessPlan
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"billingMode": {
"type": "string"
},
"status": {
"type": "string"
}
}
}ApiAccessPricing
{
"type": "object",
"additionalProperties": false,
"required": [
"unit",
"plan",
"requestCount",
"prices",
"note"
],
"properties": {
"unit": {
"type": "string",
"const": "Credits"
},
"plan": {
"$ref": "#/components/schemas/ApiAccessPlan"
},
"requestCount": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"prices": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"available",
"estimatedCredits"
],
"properties": {
"source": {
"$ref": "#/components/schemas/ApiAccessSource"
},
"available": {
"type": "boolean"
},
"creditsPerRequest": {
"type": [
"number",
"null"
],
"minimum": 0
},
"estimatedCredits": {
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Null for downloads or missing pricing."
},
"billingUnit": {
"type": "string",
"const": "TB"
},
"bytesPerUnit": {
"type": "integer",
"const": 1000000000000
},
"creditsPerTb": {
"type": [
"number",
"null"
],
"minimum": 0
},
"note": {
"type": "string"
}
}
}
},
"note": {
"type": "string"
}
}
}ApiAccessSource
{
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}ApiKey
{
"type": "object",
"description": "API key details. A key remains active until scheduledRevocationAt when revocation is scheduled.",
"additionalProperties": false,
"required": [
"id",
"name",
"prefix",
"last4",
"scopes",
"status",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^key_"
},
"name": {
"type": "string"
},
"prefix": {
"type": "string"
},
"last4": {
"type": "string",
"minLength": 4,
"maxLength": 4
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"active",
"revoked",
"expired"
]
},
"lastUsedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"scheduledRevocationAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Planned revocation time for an overlapping retiring key; null for a primary or immediately revoked key."
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}ApiKeyCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"apiKey",
"secret"
],
"properties": {
"apiKey": {
"$ref": "#/components/schemas/ApiKey"
},
"secret": {
"type": "string",
"readOnly": true,
"pattern": "^fd_(?:(?:test|live)_)?[A-Za-z0-9_-]{43}$",
"description": "Plaintext secret returned only by this create/rotate transaction. Newly issued secrets use the `fd_` prefix. Previously issued `fd_test_` and `fd_live_` secrets still authenticate. An authenticated replay with the same Idempotency-Key and request body may receive the same KMS-encrypted response for five minutes; it is not recoverable afterward.",
"x-secret-reveal": "once"
}
}
}ApiKeyUsage
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"unit",
"from",
"to",
"observedAt",
"totals",
"bySource",
"updating",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account_authorized_sources"
},
"unit": {
"type": "string",
"const": "Credits"
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"totals": {
"$ref": "#/components/schemas/UsageCounts"
},
"bySource": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"requests",
"completed",
"failed",
"credits"
],
"properties": {
"source": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0
}
}
}
},
"updating": {
"type": "boolean"
},
"note": {
"type": "string"
}
}
}BillingPaymentPage
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingPayment"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BillingPayment
{
"description": "Account-scoped top-up projection. Refund state is updated only from verified provider events; this API does not initiate refunds.",
"type": "object",
"additionalProperties": false,
"required": [
"id",
"purchaseType",
"status",
"currency",
"amount",
"refundedAmount",
"credits",
"reversedCredits",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^pay_"
},
"purchaseType": {
"type": "string",
"const": "top_up"
},
"status": {
"type": "string",
"enum": [
"pending",
"paid",
"partially_refunded",
"refunded",
"failed"
]
},
"currency": {
"type": "string",
"const": "USD"
},
"amount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"refundedAmount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"credits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"hostedInvoiceUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Stripe-hosted HTTPS invoice URL, when Stripe created an invoice for this top-up."
},
"invoiceNumber": {
"type": [
"string",
"null"
],
"description": "Stripe invoice number, when available."
},
"reversedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Cumulative credits removed by append-only payment_reversal entries; never exceeds credits."
},
"paidAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"refundedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}BulkJobCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"job",
"upload"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
},
"upload": {
"type": "object",
"additionalProperties": false,
"required": [
"href",
"method",
"expiresAt",
"contentType"
],
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "PUT"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"contentType": {
"type": "string",
"const": "text/plain; charset=utf-8"
}
}
}
}
}BulkJob
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"source",
"status",
"input",
"counts",
"delivery",
"pauseReason",
"error",
"createdAt",
"startedAt",
"completedAt",
"expiresAt",
"links"
],
"properties": {
"id": {
"type": "string",
"pattern": "^bulk_[A-Za-z0-9_-]{8,}$"
},
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"status": {
"type": "string",
"enum": [
"awaiting_upload",
"running",
"paused",
"finalizing",
"completed",
"failed",
"cancelled"
]
},
"input": {
"type": "object",
"additionalProperties": false,
"required": [
"bytes",
"complete",
"scannedBytes",
"scannedLines"
],
"properties": {
"bytes": {
"type": "integer",
"minimum": 0
},
"complete": {
"type": "boolean"
},
"scannedBytes": {
"type": "integer",
"minimum": 0
},
"scannedLines": {
"type": "integer",
"minimum": 0
}
}
},
"counts": {
"type": "object",
"additionalProperties": false,
"required": [
"accepted",
"completed",
"failed",
"invalid",
"results"
],
"properties": {
"accepted": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"invalid": {
"type": "integer",
"minimum": 0
},
"results": {
"type": "integer",
"minimum": 0
}
}
},
"pauseReason": {
"type": [
"string",
"null"
]
},
"delivery": {
"type": "object",
"additionalProperties": false,
"required": [
"customerStorage",
"storageType",
"uploadedParts",
"retryCount"
],
"properties": {
"customerStorage": {
"type": "boolean"
},
"storageType": {
"type": [
"string",
"null"
],
"enum": [
"s3",
"s3_compatible",
"oss",
"gcs",
"azure",
"cos",
"bos",
"tos",
null
]
},
"uploadedParts": {
"type": "integer",
"minimum": 0
},
"retryCount": {
"type": "integer",
"minimum": 0
}
}
},
"error": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"code",
"detail"
],
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": [
"string",
"null"
]
}
}
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"startedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobLink"
}
}
}
}BulkJobPage
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BulkJobResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
}
}
}ConsoleJob
{
"type": "object",
"additionalProperties": false,
"required": [
"createdAt",
"credits",
"durationMs",
"error",
"id",
"params",
"progress",
"result",
"source",
"status",
"updatedAt",
"videoId"
],
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"credits": {
"type": "number",
"multipleOf": 0.001
},
"durationMs": {
"type": [
"number",
"null"
],
"minimum": 0
},
"error": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": true
},
"progress": {
"type": "integer",
"minimum": 0
},
"result": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"source": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"videoId": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobLink"
}
}
}
}ConsoleOverview
{
"type": "object",
"additionalProperties": false,
"required": [
"account",
"onboarding",
"subscription",
"balance",
"publicStatus",
"degradedSections",
"generatedAt"
],
"properties": {
"account": {
"$ref": "#/components/schemas/Account"
},
"onboarding": {
"$ref": "#/components/schemas/OnboardingProgress"
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/Subscription"
},
{
"type": "null"
}
]
},
"balance": {
"oneOf": [
{
"$ref": "#/components/schemas/CreditBalance"
},
{
"type": "null"
}
]
},
"publicStatus": {
"oneOf": [
{
"$ref": "#/components/schemas/PublicStatus"
},
{
"type": "null"
}
]
},
"degradedSections": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"subscription",
"balance",
"public_status"
]
},
"description": "A listed section uses its unavailable representation; null and empty values must not be interpreted as zero or healthy."
},
"generatedAt": {
"type": "string",
"format": "date-time"
}
}
}CreateApiKeyRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"scopes"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"scopes": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}CreateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Reused for every ID. Metadata accepts include_formats and include_chapters. Transcript and captions accept language (one code or an array of 1–10 distinct codes) and auto (applies to all requested languages). Omit language to prefer en-orig, fall back to en, and return one track. With auto=true, each requested code tries its -orig track first, then the plain code. Explicit -orig codes and auto=false stay exact. languageCode identifies the selected track; requestedLanguageCode is included when it differs from the requested code. A language array returns tracks and per-language errors for each video with at least one retrieved track. If no track is retrieved, the video job fails and its reserved credits are refunded. Bulk exports use one JSONL record per video. Trainability accepts no source options. These four data sources optionally accept result_storage. Supported storage_type values are s3, s3_compatible, oss, gcs, azure, cos, bos, and tos. storage_url is the bucket name (Azure container name); object_prefix is optional. S3, S3-compatible, OSS, COS, BOS, and TOS use access_key and secret_key. S3-compatible and OSS also require a public HTTPS endpoint_url. COS, BOS, and TOS require region and use fixed provider endpoints. COS bucket names include the APPID. BOS S3-compatible HTTPS delivery supports bj, su, and hkg. GCS requires service_account with project_id, client_email, and private_key. Azure requires account_name and a container SAS sas_token with write permission. Default object_prefix is YYYYMMDD, frozen to the UTC bulk creation date. Files are written to <prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz; manifest.json in the same bulk directory is written last. Each JSONL row includes its input index and completed, failed, or invalid status. Internal R2 results remain available through the result links for 24 hours. Download accepts the normal YouTube download parameters, requires customer storage, and does not permit browser_delivery. Download storage supports the same eight provider types and credential shapes listed above under the storage field. Download storage may include object_prefix; YYYYMMDD tokens resolve to the UTC upload date, while literal prefixes are unchanged."
},
"callback_url": {
"type": "string",
"format": "uri",
"maxLength": 2048,
"description": "Optional public HTTPS endpoint notified once after manifest publication."
}
}
}CreateDeliveryWebhookRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"url"
],
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
}CreditBalance
{
"type": "object",
"additionalProperties": false,
"required": [
"balanceCredits",
"reservedCredits",
"availableCredits",
"lifetimeGrantedCredits",
"lifetimeUsedCredits",
"lifetimeRefundedCredits",
"lifetimePaymentReversedCredits",
"updatedAt"
],
"properties": {
"balanceCredits": {
"type": "number",
"multipleOf": 0.001,
"description": "Signed settled balance after grants, usage, refunds and provider reversals."
},
"reservedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"availableCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "max(balanceCredits, 0)."
},
"lifetimeGrantedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"lifetimeUsedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"lifetimeRefundedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits returned to the account after failed usage."
},
"lifetimePaymentReversedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Absolute Credits removed after verified provider refunds or chargebacks."
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}CreditEntryType
{
"type": "string",
"enum": [
"subscription_grant",
"topup_grant",
"payment_reversal",
"admin_adjustment",
"trial_grant"
]
}CreditPolicy
{
"type": "object",
"additionalProperties": false,
"required": [
"unit",
"failedRequestsCharged",
"subscriptionGrantTiming",
"refundHandling"
],
"properties": {
"unit": {
"type": "string",
"const": "credit"
},
"failedRequestsCharged": {
"type": "boolean",
"const": false
},
"subscriptionGrantTiming": {
"type": "string",
"const": "invoice_paid"
},
"refundHandling": {
"type": "string",
"const": "append_only_reversal",
"description": "Failed requests are refunded; verified provider refunds remove the proportional Credits through immutable transactions."
}
}
}CreditTransaction
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"deltaCredits",
"balanceAfterCredits",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^ctx_"
},
"type": {
"$ref": "#/components/schemas/CreditEntryType"
},
"deltaCredits": {
"type": "number",
"multipleOf": 0.001
},
"balanceAfterCredits": {
"type": [
"number",
"null"
],
"multipleOf": 0.001,
"description": "Signed settled balance after this immutable transaction, when recorded."
},
"description": {
"type": "string"
},
"requestId": {
"type": [
"string",
"null"
]
},
"jobId": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}DataSource
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"category",
"product",
"modes",
"inputSchema",
"estimatedCredits",
"requiresStorageDestination"
],
"properties": {
"id": {
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
},
"name": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"google",
"youtube"
]
},
"product": {
"type": "string",
"enum": [
"google_search",
"youtube_data",
"youtube_download"
]
},
"modes": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"description": "Only modes backed by a real adapter or consumer in the current release",
"items": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
}
},
"inputSchema": {
"type": "object",
"additionalProperties": true,
"description": "JSON Schema used by the Playground and generated clients"
},
"estimatedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"requiresStorageDestination": {
"type": "boolean",
"description": "Whether query submission must include per-request storage configuration."
}
}
}DeliveryWebhook
{
"type": "object",
"additionalProperties": false,
"required": [
"createdAt",
"id",
"lastTestStatus",
"lastTestedAt",
"name",
"status",
"updatedAt",
"url"
],
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
},
"lastTestStatus": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"lastTestedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
}
}Health
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"service",
"version",
"time"
],
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"degraded"
]
},
"service": {
"type": "string"
},
"version": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
}
}
}HostedSession
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"url",
"expiresAt"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri",
"description": "Provider-hosted HTTPS URL on a Stripe-controlled *.stripe.com host. Web clients must validate the origin and redirect from a server-only boundary."
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}Invoice
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"number",
"status",
"currency",
"total",
"amountPaid",
"refundedAmount",
"billingReason",
"createdAt",
"periodStart",
"periodEnd"
],
"properties": {
"id": {
"type": "string",
"pattern": "^inv_"
},
"number": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"open",
"paid",
"void",
"uncollectible"
]
},
"currency": {
"type": "string",
"const": "USD"
},
"total": {
"type": "integer",
"description": "USD cents"
},
"amountPaid": {
"type": "integer",
"description": "USD cents"
},
"refundedAmount": {
"type": "integer",
"minimum": 0,
"description": "Cumulative USD cents observed from verified provider events."
},
"billingReason": {
"type": [
"string",
"null"
],
"enum": [
"subscription_create",
"subscription_cycle",
"subscription_update",
null
]
},
"hostedInvoiceUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Stripe-hosted HTTPS invoice URL. Production Web clients accept only Stripe-controlled *.stripe.com origins."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"paidAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"periodStart": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"periodEnd": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}JobLink
{
"type": "object",
"additionalProperties": false,
"required": [
"rel",
"href",
"method"
],
"properties": {
"rel": {
"type": "string",
"enum": [
"self",
"results",
"content",
"download"
]
},
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "GET"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"filename": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 1
}
}
}LegalAcceptanceRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"acceptedTerms",
"termsVersion",
"privacyVersion"
],
"properties": {
"acceptedTerms": {
"type": "boolean",
"const": true
},
"termsVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"privacyVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
}LoginRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"rememberMe": {
"type": "boolean",
"default": false,
"description": "Ignored for email_verification, legal_acceptance and deletion_recovery Sessions, which always use a short fixed expiry."
}
}
}LoginResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"account",
"csrfToken",
"sessionMode"
],
"properties": {
"account": {
"$ref": "#/components/schemas/Account"
},
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
},
"sessionMode": {
"type": "string",
"enum": [
"full",
"email_verification",
"legal_acceptance",
"deletion_recovery"
]
}
}
}MarkdownQueryResult
{
"type": "object",
"required": [
"source",
"status",
"content"
],
"additionalProperties": true,
"description": "Markdown result content. content replaces the results array; other response fields such as id, source, status, usage and timestamps are preserved. No generated summary is added. Source URLs and transcript segment start/end times are retained.",
"properties": {
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"content": {
"type": "string",
"description": "Deterministic Markdown derived from the retrieved source result."
},
"usage": {
"type": "object",
"additionalProperties": true
}
}
}OAuthConnection
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"clientName",
"scope",
"status",
"createdAt",
"expiresAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
},
"clientName": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"mcp:research"
]
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}OAuthConsent
{
"type": "object",
"additionalProperties": false,
"required": [
"clientName",
"scope",
"sources",
"redirectUri",
"expiresAt"
],
"properties": {
"clientName": {
"type": "string",
"maxLength": 80
},
"scope": {
"type": "string",
"enum": [
"mcp:research"
]
},
"sources": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google_search",
"youtube_search",
"youtube_metadata",
"youtube_transcript"
]
}
},
"redirectUri": {
"type": "string",
"format": "uri"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}OnboardingProgress
{
"type": "object",
"additionalProperties": false,
"required": [
"currentStep",
"apiKeyStepStatus",
"firstRequestStatus",
"version",
"updatedAt"
],
"properties": {
"currentStep": {
"type": "string",
"enum": [
"welcome",
"api_key",
"first_request",
"completed"
]
},
"useCase": {
"type": [
"string",
"null"
],
"enum": [
"google_search",
"youtube_data",
"download",
null
]
},
"apiKeyStepStatus": {
"type": "string",
"enum": [
"pending",
"created",
"skipped"
]
},
"firstRequestStatus": {
"type": "string",
"enum": [
"pending",
"succeeded",
"skipped"
]
},
"firstApiKeyId": {
"type": [
"string",
"null"
],
"pattern": "^key_"
},
"firstRequestId": {
"type": [
"string",
"null"
],
"pattern": "^req_"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"version": {
"type": "integer",
"minimum": 0
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}Page
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}Pagination
{
"type": "object",
"additionalProperties": false,
"required": [
"hasMore",
"limit"
],
"properties": {
"nextCursor": {
"type": [
"string",
"null"
]
},
"previousCursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}Password
{
"type": "string",
"minLength": 8,
"maxLength": 128,
"writeOnly": true
}PlanCatalog
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"currency",
"billingAvailability",
"creditValueUsd"
],
"properties": {
"trialOffer": {
"description": "Current one-time trial allowance expressed as alternative PAYG usage amounts. Eligibility and approval are required. The amounts share one balance and are not additive. Null when a reliable estimate is unavailable. This is not an account eligibility decision or a promise of immediate credit issuance.",
"oneOf": [
{
"$ref": "#/components/schemas/PublicTrialOffer"
},
{
"type": "null"
}
]
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
"currency": {
"type": "string",
"const": "USD"
},
"creditValueUsd": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Fixed USD value of one credit, used to preview custom top-ups. The server computes the credited amount."
},
"billingAvailability": {
"type": "string",
"enum": [
"available",
"unconfigured",
"unavailable"
]
},
"billingMessage": {
"type": [
"string",
"null"
],
"description": "Stable, non-sensitive explanation suitable for the Pricing and Billing UI."
}
}
}Plan
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"slug",
"name",
"description",
"includedCredits",
"limits",
"prices",
"features",
"usagePrices"
],
"properties": {
"id": {
"type": "string",
"pattern": "^plan_"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"includedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits included in each paid subscription cycle; zero for Pay As You Go."
},
"limits": {
"$ref": "#/components/schemas/PlanLimits"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanPrice"
}
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"usagePrices": {
"$ref": "#/components/schemas/PlanUsagePrices"
}
}
}PlanLimits
{
"type": "object",
"additionalProperties": false,
"required": [
"concurrency",
"maxBatchSize",
"maxPendingJobs"
],
"properties": {
"concurrency": {
"type": "integer",
"minimum": 1
},
"maxBatchSize": {
"type": "integer",
"minimum": 1
},
"maxPendingJobs": {
"type": "integer",
"minimum": 1
}
}
}PlanPrice
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"currency",
"unitAmount",
"credits",
"type",
"interval"
],
"properties": {
"id": {
"type": "string",
"pattern": "^prc_"
},
"currency": {
"type": "string",
"const": "USD"
},
"unitAmount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"credits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits granted by a successful one-time top-up; zero for recurring prices."
},
"type": {
"type": "string",
"enum": [
"recurring",
"one_time"
]
},
"interval": {
"type": [
"string",
"null"
],
"enum": [
"month",
"year",
null
]
}
}
}PlanUsagePrices
{
"type": "object",
"additionalProperties": false,
"required": [
"googlePer1kCents",
"youtubePer1kCents",
"downloadPerTbCents"
],
"properties": {
"googlePer1kCents": {
"type": "integer",
"minimum": 0,
"description": "Google request price per 1,000 successful requests, in USD cents."
},
"youtubePer1kCents": {
"type": "integer",
"minimum": 0,
"description": "Standard YouTube request price per 1,000 successful requests, in USD cents."
},
"downloadPerTbCents": {
"type": "integer",
"minimum": 0,
"description": "Download price per decimal TB (1,000,000,000,000 bytes), in USD cents."
}
}
}Problem
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"properties": {
"type": {
"type": "string",
"format": "uri-reference"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599
},
"code": {
"type": "string",
"pattern": "^[a-z0-9_]+$"
},
"detail": {
"type": "string"
},
"requestId": {
"type": "string",
"pattern": "^req_"
},
"fieldErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldError"
}
}
}
}FieldError
{
"type": "object",
"additionalProperties": false,
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}PublicLegalVersions
{
"type": "object",
"additionalProperties": false,
"required": [
"availability",
"termsVersion",
"privacyVersion"
],
"properties": {
"availability": {
"type": "string",
"enum": [
"configured",
"unconfigured"
]
},
"termsVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 64
},
"privacyVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 64
}
}
}PublicStatus
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"updatedAt",
"components"
],
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"degraded",
"outage"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicStatusComponent"
}
}
}
}PublicStatusComponent
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"status"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"operational",
"degraded",
"outage"
]
}
}
}PublicTrialOffer
{
"type": "object",
"additionalProperties": false,
"required": [
"googleSearchRequests",
"youtubeDataRequests",
"downloadGigabytes"
],
"properties": {
"maxApiRequests": {
"type": "integer",
"minimum": 0,
"description": "Maximum free API calls when the entire trial grant is spent on the lowest-cost per-request API at current Pay as you go rates. Other APIs may allow fewer calls. Downloads are billed by delivered bytes and excluded from this count."
},
"googleSearchRequests": {
"type": "integer",
"minimum": 0,
"description": "Requests if the entire grant is spent on Google sources, using the highest current source rate."
},
"youtubeDataRequests": {
"type": "integer",
"minimum": 0,
"description": "Standard YouTube requests, excluding Extended Search, using the highest current source rate."
},
"downloadGigabytes": {
"type": "number",
"minimum": 0,
"description": "Approximate delivered media volume in decimal GB (1 GB = 1000000000 bytes). Zero when the grant cannot cover the initial download reservation. Completion also depends on per-job reservations and settlement."
}
}
}QueryRepresentationError
{
"type": "object",
"required": [
"error",
"code",
"message"
],
"properties": {
"error": {
"type": "boolean",
"const": true
},
"code": {
"type": "string",
"enum": [
"unsupported_representation",
"not_acceptable"
]
},
"message": {
"type": "string"
}
}
}Reauthentication
{
"type": "object",
"additionalProperties": false,
"required": [
"reauthenticatedUntil"
],
"properties": {
"reauthenticatedUntil": {
"type": "string",
"format": "date-time"
}
}
}RegisterRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"email",
"password",
"acceptedTerms",
"termsVersion",
"privacyVersion"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Optional display name. When omitted, defaults to the normalized email local part, truncated to 100 characters. Can be changed in the profile later."
},
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"password": {
"$ref": "#/components/schemas/Password"
},
"acceptedTerms": {
"type": "boolean",
"const": true
},
"termsVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Exact version rendered by the signup page; stale versions are rejected."
},
"privacyVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Exact version rendered by the signup page; stale versions are rejected."
}
}
}RegisterResponse
{
"type": "object",
"additionalProperties": false,
"description": "Generic receipt returned for both a new account and a recoverable pending account. It intentionally omits identity data to limit account enumeration.",
"required": [
"emailVerificationRequired"
],
"properties": {
"emailVerificationRequired": {
"type": "boolean",
"const": true
}
}
}Session
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"current",
"mode",
"createdAt",
"lastSeenAt",
"expiresAt",
"device"
],
"properties": {
"id": {
"type": "string",
"pattern": "^ses_"
},
"current": {
"type": "boolean"
},
"mode": {
"type": "string",
"enum": [
"full",
"email_verification",
"legal_acceptance",
"deletion_recovery"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"lastSeenAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"device": {
"type": "string"
},
"approximateLocation": {
"type": "string"
},
"reauthenticatedUntil": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}Subscription
{
"type": "object",
"description": "Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.",
"additionalProperties": false,
"required": [
"status",
"plan",
"cancelAtPeriodEnd",
"usageRates"
],
"properties": {
"id": {
"type": [
"string",
"null"
],
"pattern": "^sub_"
},
"status": {
"type": "string",
"enum": [
"payg",
"trialing",
"active",
"past_due",
"grace",
"cancelled"
]
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"usageRates": {
"type": "object",
"description": "Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.",
"additionalProperties": false,
"required": [
"customized",
"queries",
"downloadCreditsPerTb"
],
"properties": {
"customized": {
"type": "boolean",
"description": "True when an administrator configured rates for this account."
},
"queries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"name",
"creditsPerRequest"
],
"properties": {
"source": {
"type": "string"
},
"name": {
"type": "string"
},
"creditsPerRequest": {
"type": "number",
"minimum": 0
}
}
}
},
"downloadCreditsPerTb": {
"type": "number",
"minimum": 0
}
}
},
"currentPeriodStart": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"currentPeriodEnd": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"graceEndsAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}SubscriptionCancellationChange
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"cancelAtPeriodEnd",
"status"
],
"properties": {
"id": {
"type": "string",
"pattern": "^sub_"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"submitted"
]
}
}
}SubscriptionChange
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"fromPriceId",
"toPriceId",
"effective",
"status"
],
"properties": {
"id": {
"type": "string",
"pattern": "^sub_",
"description": "FlashData subscription public ID. Entitlement still updates only after a verified provider event."
},
"fromPriceId": {
"type": "string",
"pattern": "^prc_"
},
"toPriceId": {
"type": "string",
"pattern": "^prc_"
},
"effective": {
"type": "string",
"enum": [
"immediate"
]
},
"status": {
"type": "string",
"enum": [
"submitted"
]
}
}
}TokenRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
}
}
}TrialCreditState
{
"type": "object",
"additionalProperties": false,
"required": [
"eligible",
"ineligibilityReason",
"grantCredits",
"settingsVersion",
"request"
],
"properties": {
"eligible": {
"type": "boolean"
},
"ineligibilityReason": {
"type": [
"string",
"null"
],
"enum": [
"account_inactive",
"email_unverified",
"onboarding_incomplete",
"not_payg",
"payment_history",
"already_granted",
"already_requested",
null
]
},
"grantCredits": {
"type": "integer",
"minimum": 1
},
"settingsVersion": {
"type": "integer",
"minimum": 0
},
"request": {
"oneOf": [
{
"$ref": "#/components/schemas/TrialCreditRequest"
},
{
"type": "null"
}
]
}
}
}TrialCreditRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"status",
"requestedCredits",
"policyVersion",
"useCase",
"requestedAt",
"reviewedAt",
"reviewReason",
"version"
],
"properties": {
"id": {
"type": "string",
"pattern": "^tcr_[A-Za-z0-9_-]{8,}$"
},
"status": {
"$ref": "#/components/schemas/TrialCreditRequestStatus"
},
"requestedCredits": {
"type": "integer",
"minimum": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0
},
"useCase": {
"type": [
"string",
"null"
],
"enum": [
"google_search",
"youtube_data",
"download",
null
]
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"reviewedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"reviewReason": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer",
"minimum": 0
}
}
}TrialCreditRequestStatus
{
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
]
}UpdateAccountRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
}UpdateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"options": {
"type": "object",
"additionalProperties": true,
"description": "Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored."
},
"callback_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 2048,
"description": "Replacement completion callback, or null to remove the callback."
}
}
}UpdateOnboardingRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"version",
"action"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"enum": [
"select_use_case",
"confirm_api_key_saved",
"skip_api_key",
"confirm_first_request",
"skip_first_request"
]
},
"useCase": {
"type": "string",
"enum": [
"google_search",
"youtube_data",
"download"
]
}
},
"allOf": [
{
"if": {
"properties": {
"action": {
"const": "select_use_case"
}
}
},
"then": {
"required": [
"useCase"
],
"properties": {
"useCase": {}
}
},
"else": {
"not": {
"required": [
"useCase"
],
"properties": {
"useCase": {}
}
}
}
}
],
"description": "Server-owned resource state validates confirmation actions; clients never submit API Key or request IDs."
}UsageCounts
{
"type": "object",
"additionalProperties": false,
"required": [
"requests",
"completed",
"failed",
"credits"
],
"properties": {
"requests": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0,
"description": "Charged Credits in the current aggregate; pending work may not be finally settled."
}
}
}