เรียกดูเอกสาร
เอกสารอ้างอิง API
การจัดการ API อ้างอิง
เลือกจุดปลายสําหรับบัญชี, กุญแจ, ค่าใช้จ่ายและงาน จุด จบ แต่ ละ จุด จะ ลง รายการ การ พิสูจน์ และ ข้อ เรียก ร้อง ของ ตน เอง.
อ่านบัญชีผู้ใช้ของคุณด้วยกุญแจ API
การจัดการ API ฐาน URL คือ https://api.flashdata.dev/v2. การอ่านฟรีนี้ จะคืนค่ากลับมาเป็นกุญแจและบัญชีผู้ใช้ปัจจุบัน IDs และเป็นเจ้าของ ตั้งค่า FLASHDATA_API_KEY ก่อนที่จะใช้คําสั่ง
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'คาด HTTP 200 ความสําเร็จ ตรวจสอบบรรทัดการตรวจสอบสิทธิ์ของแต่ละจุด: dataApiKey ใช้ X-API-Key; cookieSession ใช้วาระการใช้งานของเบราว์เซอร์ที่มีชื่อล็อกอิน การตอบสนองของการแสดงตัว Schema
ดาวน์โหลดค่าการกําหนด OpenAPI ของลูกค้า. มันครอบคลุมการสืบพันธุ์ งาน บัญชี API กุญแจและค่าใช้จ่าย
สืบค้นพารามิเตอร์และโปรแกรมที่ร้องขอมีเอกสารอยู่ใน Google ถึง YouTube API อ้างอิง
ชุดการตรวจสอบสิทธิ์
| ชุดสี | เงื่อนไข |
|---|---|
dataApiKey |
FlashData API กุญแจ การเข้าใช้งานถูกจํากัดให้อยู่ในขอบเขตของกุญแจ |
cookieSession |
Opaque interctions. เบราว์เซอร์ไม่สามารถอ่านคุกกี้นี้ได้ |
csrfToken |
apiKey |
agentRegistrationProof | ต่อเนื่องกับการสุ่มทางจิตวิทยา 32- ไบต์ การพิสูจน์ฐาน64url และคําร้องขอที่แน่นอน ก่อนที่จะส่ง; กู้คืนด้วยหลักฐานและร่างกายเดียวกันเท่านั้น ไม่ใช่ป้าย OAuth |
agentSetupCredential | การตั้งค่าชั่วคราวที่เชื่อถือได้สําหรับสถานะและเรียกร้องเท่านั้น ไม่มีข้อมูลกุญแจ API |
agentHandoffProof | การพิสูจน์ใช้เพื่อเรียกคืนกุญแจของเจ้าของ และยอมรับการติดตั้ง ไม่เคยถูกส่งไปสอบถามข้อมูล |
agentIdentityKey | ปกติ FlashData API กุญแจในสัญญาอนุญาตบัตร เฉพาะกับตัวแทน ชุดข้อมูลที่จะใช้ X-API-Key แทน |
ระบบ
GET/health
สุขภาพ ของ ผู้ รับ ใช้
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 สุขภาพ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
อ่านสรุปสถานะขององค์ประกอบสาธารณะ
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 สรุปสถานะสาธารณะ
ส่วนหัว: Cache-Control
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}แบบ Auth
GET/oauth/requests/{requestId}
อ่านการร้องขออนุญาตโปรแกรมและแนบมันไปยังวาระการใช้งานปัจจุบัน
ต้องการทุกวาระ การร้องขอหมดอายุหลังจากผ่านไป 10 นาที การตอบโต้ไม่รุนแรง
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
requestId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}การตอบโต้
200 สิทธิ์ที่โปรแกรมต้องการ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 การร้องขอหมดอายุ, การใช้, หรือมีการผูกพันกับวาระการใช้งานอื่น ๆ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
ยอมรับหรือปฏิเสธการร้องขออนุมัติจากโปรแกรม
เซสชันเต็ม, CSRF และอนุญาตให้ใช้ต้นฉบับ เรียกร้องครั้งเดียว การตอบโต้ไม่รุนแรง
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
requestId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}การตอบโต้
200 โปรแกรมลูกข่ายแจ้งกลับมาพร้อมรหัสหรือปฏิเสธ, รัฐและผู้ออกใบรับรอง
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 ไม่สามารถใช้คําสั่งยืนยันได้; เริ่มการเชื่อมต่อใหม่
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
สร้างการรอเวลา FlashData บัญชี
ส่วน ที่ ส่ง มา นี้ ต้อง มี การ จัด พิมพ์ ตาม ประมวล กฎหมาย ใน ปัจจุบัน.
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}การตอบโต้
201 บัญชีผู้ใช้ที่สร้าง; ต้องการตรวจความถูกต้องของอีเมล
ส่วนหัว: Cache-Control, X-Request-Id
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตรา, ความสอดคล้อง, จํานวนครั้งที่เล่น, หรือค่าจํากัดงานเกินขอบเขต
ส่วนหัว: Retry-After
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
สร้างวาระการใช้งานเว็บแบบ OPACque
ตั้งค่าการรักษาความปลอดภัย, คุกกี้ `__Host-fd_session`. บัญชีผู้ใช้แบบวนรอบ รับค่าการจํากัด email_verification วาระงานสําหรับหน้าปัดตรวจสอบ บัญชีที่ตรวจสอบได้ถูกต้อง ได้รับเครดิตของพวกเขาครั้งเดียวในการทดสอบใน การล็อกอินถ้ายังไม่ได้ให้ บัญชีผู้ใช้ที่ทํางานอยู่ ได้รับวาระการใช้งานเต็มรูปแบบจนกว่า การแสดงตัวการอพยพของมันจะยังต้องการ การยอมรับตามกฎหมายในปัจจุบัน ซึ่งในกรณีที่ได้รับข้อจํากัด legal_acceptance การประชุม บัญชีผู้ใช้ที่มีกําหนดการขอลบ ได้รับค่าจํากัด deletion_recovery การประชุม บัญชี ที่ ถูก ลบ ออก คือ processing/failed/completedและระงับการคิดบัญชี 403.
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}การตอบโต้
200 การตรวจสอบสิทธิ์
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ห้ามล็อกอิน Problem.code คือ email_not_verified, account_suspended, account_deletion_processing, account_deletion_failedหรือ account_deleted
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 บัญชีผู้ใช้ถูกล็อคชั่วคราว
ส่วนหัว: Retry-After
423 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตรา, ความสอดคล้อง, จํานวนครั้งที่เล่น, หรือค่าจํากัดงานเกินขอบเขต
ส่วนหัว: Retry-After
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
เรียกคืนวาระงานปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
204 ยกเลิกวาระงานและล้างคุกกี้แล้ว
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
อ่านบัญชีผู้ใช้และผู้ใช้ปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 บัญชีปัจจุบัน
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Account"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
รับ CSRF แสดงที่แนบมาด้วยวาระงานปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 CSRF ตั๋ว
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
ร้องขอหรือทําการแก้ไขจดหมายตรวจสอบอีเมล
สําหรับอีเมลที่ใช้ได้ทุกฉบับ โดยจะตอบกลับเดียวกัน ไม่ว่าบัญชีผู้ใช้จะขาดหาย, ทํางานอยู่, หรือถูกลบออกไป บัญชีที่รอได้ ได้รับการเชื่อมต่อครั้งเดียว หลังจากปรับระดับความเย็น
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}การตอบโต้
202 การ ขอ รับ. การตอบสนองไม่ได้แสดงว่ามีบัญชีผู้ใช้อยู่หรือไม่
ส่วนหัว: Cache-Control, X-Request-Id
202 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 การร้องขอการตรวจสอบสิทธิ์ของนิรนามล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตราการยืนยันตัวบุคคลไม่ถูกต้องเกินขนาด
ส่วนหัว: Cache-Control, Retry-After, X-Request-Id
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดในการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่มีข้อมูลสิ่งเชื่อมโยงสําหรับการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
ตรวจสอบอีเมลและเปิดใช้งานบัญชีผู้ใช้
โดยอะตอมแล้วจะบริโภคเหรียญเพียงครั้งเดียว และเปิดใช้งานบัญชีและผู้ใช้ การมีบัญชีและใช้กฏการทดลอง ไม่มีวาระงานการเซ็น ปูมบันทึกของผู้ใช้โดยตรง การร้องขอที่อนุญาตในการนําวาระการลงชื่อเข้าคู่ และมี X-CSRF-Token อาจได้รับคุกกี้ของเซสชันที่หมุนแล้ว สําหรับบัญชีผู้ใช้เดียวกัน; เป็นเครื่องหมายตรวจสอบเฉพาะผู้ใช้เท่านั้น
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}การตอบโต้
200 บัญชีผู้ใช้ถูกเปิดใช้งาน
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 ตั๋วหนึ่งใบไม่ถูกต้อง, หมดอายุแล้ว, ถูกใช้ไปแล้ว, หรือสูญเสียรายการยืนยันการเกิดขึ้นอีก Problem.code คือ `token_unavailable`.
ส่วนหัว: Cache-Control, X-Request-Id
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ของนิรนามล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตราการยืนยันตัวบุคคลไม่ถูกต้องเกินขนาด
ส่วนหัว: Cache-Control, Retry-After, X-Request-Id
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดในการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่มีข้อมูลสิ่งเชื่อมโยงสําหรับการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
ทําการเซ็นวาระการเขียนดั้งเดิมหลังจากตรวจสอบอีเมลแล้ว
ต้องการต้นกําเนิดและ CSRF แสดงที่แนบมาด้วยวาระการใช้งานอีเมลแบบมีรหัสผ่านใช้งานอยู่ การกลับมาเพื่อรอตรวจสอบบัญชีผู้ใช้ของกลุ่มงานดังกล่าว รวมถึงการตรวจสอบในเบราว์เซอร์อื่นด้วย สัมพัทธภาพเพื่อกระตุ้นการลงชื่อ และก่อปัญหาความพร้อมหรือการยอมรับตามกฎหมาย ไม่รับบัญชี IDอีเมล์, รหัสผ่าน หรือตั๋วรับรอง, ผ่านการยอมรับตามกฏหมาย, หรือให้เครดิต
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false
}การตอบโต้
200 หมุนวาระการใช้งานแบบเซ็น
ส่วนหัว: Set-Cookie, Cache-Control
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 การตรวจสอบอีเมลจะอยู่ระหว่าง; ไม่มีวาระการเชื่อมต่อใหม่
ส่วนหัว: Cache-Control
202 ตอบกลับ · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
ต้องการรหัสผ่านใหม่จากอีเมล
จะคืนค่ากลับมาเป็นค่าเดิมเสมอ 202 การตอบสนองสําหรับอีเมลที่ใช้ได้ ไม่คํานึงถึงการมีอยู่ของบัญชี หรือสถานะวงจรชีวิต ได้รับเฉพาะจดหมายที่แอ็กทีฟหรือถูกล็อคไว้เท่านั้น
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}การตอบโต้
202 การ ขอ รับ. การตอบสนองไม่ได้แสดงว่ามีบัญชีผู้ใช้อยู่หรือไม่
ส่วนหัว: Cache-Control, X-Request-Id
202 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 การร้องขอการตรวจสอบสิทธิ์ของนิรนามล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตราการยืนยันตัวบุคคลไม่ถูกต้องเกินขนาด
ส่วนหัว: Cache-Control, Retry-After, X-Request-Id
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดในการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่มีข้อมูลสิ่งเชื่อมโยงสําหรับการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
ตั้งค่ารหัสผ่านใหม่และเรียกคืนวาระงานที่มีอยู่แล้ว
การใช้รหัสผ่านแบบอะตอม จะทําการจัดเก็บค่าความเชื่อถือของอาร์กอน2id ใหม่, เปิดใช้งานทุกวาระการทํางานที่มีอยู่, และทําให้เครื่องหมายถอดรหัสผ่านอื่น ๆ ใช้งานไม่ได้ ไม่ได้ล็อกอินหรือสร้างกลุ่มผู้ใช้
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}การตอบโต้
204 การปรับปรุงรหัสผ่าน; ยกเลิกวาระงานที่มีอยู่แล้ว
ส่วนหัว: Cache-Control, X-Request-Id
410 ตั๋วหนึ่งใบไม่ถูกต้อง, หมดอายุแล้ว, ถูกใช้ไปแล้ว, หรือสูญเสียรายการยืนยันการเกิดขึ้นอีก Problem.code คือ `token_unavailable`.
ส่วนหัว: Cache-Control, X-Request-Id
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ของนิรนามล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตราการยืนยันตัวบุคคลไม่ถูกต้องเกินขนาด
ส่วนหัว: Cache-Control, Retry-After, X-Request-Id
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดในการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่มีข้อมูลสิ่งเชื่อมโยงสําหรับการตรวจสอบสิทธิ์ที่ไม่มีชื่อ
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
รายการวาระการใช้งานที่ทํางานอยู่สําหรับผู้ใช้ปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 วาระการใช้งาน
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
เรียกคืนวาระงานทั้งหมดยกเว้นวาระปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
204 ยกเลิกวาระงานอื่น ๆ
ส่วนหัว: Cache-Control, X-Request-Id
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
เรียกคืนวาระงานหนึ่งตัว
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
sessionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^ses_"
}การตอบโต้
204 ยกเลิกวาระการใช้งาน ถ้ามันเป็นกลุ่มงานในปัจจุบัน คุกกี้ก็เคลียร์
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
ตรวจสอบรหัสผ่านปัจจุบันสําหรับปฏิบัติการที่ละเอียดอ่อน
บันทึกการพิสูจน์เมื่อเร็ว ๆ นี้เกี่ยวกับวาระเซิร์ฟเวอร์ปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}การตอบโต้
200 วาระงานมีการตรวจสอบสิทธิ์ล่าสุด
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อัตรา, ความสอดคล้อง, จํานวนครั้งที่เล่น, หรือค่าจํากัดงานเกินขอบเขต
ส่วนหัว: Retry-After
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
เปลี่ยนรหัสผ่านและหมุนวาระงานปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · 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
}
}
}การตอบโต้
204 รหัสผ่านมีการเปลี่ยนแปลง วาระงานปัจจุบันถูกหมุนและวาระการใช้งานอื่น ๆ ถูกยกเลิกเมื่อร้องขอ
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}บัญชี
GET/oauth/connections
เรียกรายการโปรแกรมของบัญชีผู้ใช้ที่เชื่อมต่ออยู่
ต้องการทุกวาระ ว่างเมื่อบัญชีผู้ใช้ไม่มีโปรแกรมที่เชื่อมต่ออยู่ การตอบโต้ไม่รุนแรง
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 Connected apps
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
เรียกโปรแกรมที่เชื่อมต่ออยู่และอุทิศให้ API กุญแจ
เซสชันเต็ม, CSRF และอนุญาตให้ใช้ต้นฉบับ การเป็นเจ้าของบัญชีถูกบังคับใช้ การตอบโต้ไม่รุนแรง
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
grantId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}การตอบโต้
204 ยกเลิกการอนุญาตสิทธิ์
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
กําลังอ่านค่าบัญชีผู้ใช้
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 บัญชี
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Account"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
ปรับปรุงการตั้งค่าโพรไฟล์
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}การตอบโต้
200 ปรับปรุงบัญชีผู้ใช้
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Account"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
การลบบัญชีผู้ใช้ในตาราง และยกเลิกการเรียกใช้วาระการใช้งานที่มีอยู่ทั้งหมด API Keys
บัญชีผู้ดูแลต้องถูกเพิกถอนบทบาทแพลตฟอร์มผ่านขั้นตอนของผู้ปฏิบัติงานที่มีบันทึกการตรวจสอบก่อนกำหนดเวลาลบ คำขอลบที่ยังใช้งานอยู่หนึ่งรายการเป็นขอบเขตของ idempotency การส่งคำขอกำหนดเวลาที่ผ่านการยืนยันตัวตนพร้อมกันจะคืนคำขอเดียวกัน หลังเพิกถอน Session แล้ว หากการตอบกลับสูญหาย ให้เข้าสู่โหมด deletion_recovery และอ่าน GET /account/deletion ระบบไม่ยอมรับ Session ที่ถูกเพิกถอนสำหรับการส่งซ้ำ
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}การตอบโต้
202 กําหนดการลบ; วาระการใช้งานและกุญแจที่ทํางานอยู่
202 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
อ่านการร้องขอลบบัญชีปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 การร้องขอการลบข้อมูลปัจจุบัน
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
ยกเลิกการลบรายการในวาระของพระคุณ
ใช้ compare-and-set เพื่อเปลี่ยนสถานะจาก scheduled เป็น cancelled หากเกิดการแข่งขันกับตัวประมวลผล จะคืน 409 หลังสำเร็จ ระบบเปลี่ยน recovery Session ใหม่ จึงไม่สามารถส่งการเปลี่ยนสถานะเดิมซ้ำได้
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
204 ยกเลิกการเชื่อมต่อ, การเปิดบัญชี และการเรียกคืนวาระการใช้งานหมุนตามประตูที่ยอมรับตามกฎหมาย
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept ซึ่งตีพิมพ์ในภาคต่อและเวอร์ชันปัจจุบัน
เพิ่มการยอมรับตามกฎหมายที่ไม่สามารถเปลี่ยนแปลงได้ ล้างประตูการอพยพ และหมุนเซสชั่น ถูกปฏิเสธรุ่นที่ส่งไปแล้ว
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}การตอบโต้
200 การยอมรับทางกฎหมายที่ถูกบันทึกและกลุ่มงาน ถูกปรับให้เป็นแบบเต็มโหมด
ส่วนหัว: Set-Cookie, Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}บนกระดาน
GET/onboarding
อ่านต่อจากฐานข้อมูลได้
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 สถานะที่อยู่บนเครื่องปัจจุบัน
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
ส่วนหัว: Cache-Control, X-Request-Id
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ มี การ ติด ต่อ กับ บุคคล ใด ๆ หรือ ไม่ มี แผ่น เสียง บน เครื่อง บิน นี้ อยู่ ชั่ว คราว
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
ความก้าวหน้าบนระบบโดยไม่อนุญาตให้ความคืบหน้าย้ายย้อนกลับ
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}การตอบโต้
200 ปรับปรุงสถานะการขึ้นบน
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
ส่วนหัว: Cache-Control, X-Request-Id
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
ส่วนหัว: Cache-Control, X-Request-Id
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ มี การ ติด ต่อ กับ บุคคล ใด ๆ หรือ ไม่ มี แผ่น เสียง บน เครื่อง บิน นี้ อยู่ ชั่ว คราว
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}ภาพรวม
GET/overview
อ่านกลุ่มของบัญชีผู้ใช้
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ภาพรวมของบัญชีผู้ใช้ที่ถูกคัดลอก
ส่วนหัว: Cache-Control, X-Request-Id
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
ส่วนหัว: Cache-Control, X-Request-Id
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ มี การ ติด ต่อ กับ บุคคล ใด ๆ หรือ ไม่ มี แผ่น เสียง บน เครื่อง บิน นี้ อยู่ ชั่ว คราว
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
ตรวจสอบปัจจุบัน API การเป็นเจ้าของที่สําคัญและพร้อมอีกครั้ง
อ่านค่าหัวกระดาษอิสระแบบ API-คีย์ ผลตอบแทนสู่สาธารณชน account/key IDs และเป็นเจ้าของกิจการ ไม่มีศพที่ร้องขอ ไม่สามารถเปลี่ยนรายการที่มีอยู่ /api-access การตอบรับข้อมูล แบ่งปันกัน 120/minute จํากัดการอ่านบัญชี การปิดการทํางานอย่างล้มเหลว; อย่าตรวจสอบความเป็นเจ้าของจากกุญแจนําหน้า, วางแผน, หรือรัฐท้องถิ่น ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ตรวจสอบปัจจุบัน API การเป็นเจ้าของที่สําคัญและพร้อมอีกครั้ง
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
รายการ API ข้อมูลกํากับภาพแบบกุญแจ
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 API Keys โดยปราศจากความลับ
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
สร้างรายการ API กุญแจ และ เผย ความ ลับ ครั้ง หนึ่ง
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}การตอบโต้
201 สร้าง; การเล่นซ้ําแบบอิดิโมตเดียวกันอาจส่งการตอบรับที่เข้ารหัสไว้เดิมเป็นเวลา 5 นาที
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
เรียกคืน API คีย์
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
keyId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^key_"
}การตอบโต้
204 รับคืนแล้ว
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
สร้างปุ่มพิมพ์และกําหนดการเรียกดูข้อมูลเก่า
สร้างกุญแจใหม่และคงปุ่มพิมพ์เดิมที่ทํางานอยู่จนกระทั่ง revokeOldAt โดยปริยายแล้ว จะเป็นการทับกันล่าสุด 24 ชั่วโมงหรือจนกว่ากุญแจเก่าจะหมดอายุ ซึ่งจะเป็นก่อนหน้า กําหนดเอง revokeOldAt ต้องอยู่ในอนาคต ภายใน 7 วัน และไม่ช้ามากไปกว่า การหมดอายุของกุญแจเก่า
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
keyId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ตัวเลือก
ชุดรูปแบบ · 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."
}
}
}การตอบโต้
201 การแทนที่ถูกสร้าง; เคล็ดลับที่ส่งกลับมาครั้งเดียว
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
อ่านการโทรสิ API แหล่งที่มาและผลลัพธ์ของกุญแจที่ได้รับอนุญาต
อิสระ, ส่วนหัวอย่างเดียว X-API-Key ยืนยัน ผลตอบแทนจะให้แก่สาธารณชนเท่านั้น ชื่อแหล่งและที่มาของคลังจดหมายที่เซ็นรับรองไว้ (March of authority)null ถ้า ไม่ว่าง). ไม่มีบัญชีผู้ใช้ ID, กุญแจ IDความลับหรือเอกสารลับจะถูกคืน ภายใน MCP ปรับปรุงจุดปลายนี้ ก่อนที่ทุกการค้นพบเครื่องมือและโทร รวมการอ่านผลที่ได้จากแคชด้วย ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถามหรือร้องขอตัวใด ๆ ทั้งหมด /api-access เส้นทางที่ใช้ร่วมกัน 120 ต้องการต่อนาทีต่อไคลเอนต์ IP และส่งกลับ แคช-คอนโทรล ส่วนตัว, ไม่รบกวน ยังพบกุญแจปกติที่ใช้ล่าสุด
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ก่อตั้งแหล่งสาธารณะและผลที่ออกมา
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อ่านบัญชีผู้ใช้มากเกินไป; ลองใหม่หลังจากอ่านหน้าต่างที่มีอัตรา- ระดับ
503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}การเชื่อมต่อของเจ้าหน้าที่
GET/agent-connections/capabilities
ค้นพบโพรโทคอล 2 เชื่อมต่อได้
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ค้นพบโพรโทคอล 2 เชื่อมต่อได้
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
สร้างหรือเรียกคืนการเชื่อมต่อชั่วคราวของ API-key
ดําเนินการตรวจสอบการลงทะเบียนและป้อนค่าที่แน่นอนก่อนที่ POST ข้อพิสูจน์และร่างกายเดียวกันได้การทดลองแบบเดียวกัน การเปลี่ยนข้อมูลทําให้เกิดความขัดแย้ง การทดลองชั่วคราว: 1 เครดิต 72 ชั่วโมง 1 request/secondขนาดแผ่น 1. การจํากัดขอบเขตแหล่งยังคงมีผลบังคับใช้บนเซิร์ฟเวอร์ ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentRegistrationProof
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}การตอบโต้
201 สร้างหรือเรียกคืนการเชื่อมต่อชั่วคราวของ API-key
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
รายการการเชื่อมต่อที่เบราว์เซอร์เป็นเจ้าของ
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน ปฏิบัติการของเบราว์เซอร์ ต้องการวาระการตรวจสอบเต็มรูปแบบ; การเรียกจะต้องไม่แทนที่ API กุญแจหรือหลักฐาน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 รายการการเชื่อมต่อที่เบราว์เซอร์เป็นเจ้าของ
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
อ่านสถานะการเชื่อมต่อชั่วคราว
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentSetupCredential
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}การตอบโต้
200 อ่านสถานะการเชื่อมต่อชั่วคราว
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
เรียกคืนการเชื่อมต่อที่เป็นเจ้าของ
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน ปฏิบัติการของเบราว์เซอร์ ต้องการวาระการตรวจสอบเต็มรูปแบบ; การเรียกจะต้องไม่แทนที่ API กุญแจหรือหลักฐาน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}X-CSRF-Token · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}การตอบโต้
204 เรียกคืนการเชื่อมต่อที่เป็นเจ้าของ
400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
ตรวจสอบข้อมูลปัจจุบัน API กุญแจสําหรับการเชื่อมต่อ
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentIdentityKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}การตอบโต้
200 ตรวจสอบข้อมูลปัจจุบัน API กุญแจสําหรับการเชื่อมต่อ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
อ่านได้โดยขึ้นบนรัฐ
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentHandoffProof
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}การตอบโต้
200 อ่านได้โดยขึ้นบนรัฐ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
สร้างการอ้างสิทธิ์ที่อนุญาตของเบราว์เซอร์
เปิด claimPath สําหรับผู้ที่เชื่อถือต่ออัลกุรอาน FlashData จุดกําเนิดเว็บและแสดงรหัสแยก ห้ามระบุตัวตนหรือรหัสยืนยันใน URL ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentSetupCredential
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}การตอบโต้
201 สร้างการอ้างสิทธิ์ที่อนุญาตของเบราว์เซอร์
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
ยืนยันสิทธิ์ที่อ้างถึงในวาระงานของเบราว์เซอร์
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน ปฏิบัติการของเบราว์เซอร์ ต้องการวาระการตรวจสอบเต็มรูปแบบ; การเรียกจะต้องไม่แทนที่ API กุญแจหรือหลักฐาน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
claimId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}X-CSRF-Token · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}การตอบโต้
200 ยืนยันสิทธิ์ที่อ้างถึงในวาระงานของเบราว์เซอร์
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
อ่านสิ่งที่ยืนยันแล้วในวาระการใช้งานของเบราว์เซอร์
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน ปฏิบัติการของเบราว์เซอร์ ต้องการวาระการตรวจสอบเต็มรูปแบบ; การเรียกจะต้องไม่แทนที่ API กุญแจหรือหลักฐาน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
claimId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}การตอบโต้
200 อ่านสิ่งที่ยืนยันแล้วในวาระการใช้งานของเบราว์เซอร์
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
ยอมรับขอบเขตที่ลดน้อยลง และงบประมาณในบัญชี
ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน ปฏิบัติการของเบราว์เซอร์ ต้องการวาระการตรวจสอบเต็มรูปแบบ; การเรียกจะต้องไม่แทนที่ API กุญแจหรือหลักฐาน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
claimId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}X-CSRF-Token · header · ต้องการ
ชุดรูปแบบ
{
"type": "string"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}การตอบโต้
200 ยอมรับขอบเขตที่ลดน้อยลง และงบประมาณในบัญชี
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 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
กู้เจ้าของที่อนุมัติ API กุญแจ
กุญแจสําหรับเลือกจะหมดอายุ 24 หลายชั่วโมงจนกว่าการติดตั้งจะเสีย อย่างต่อเนื่องอะตอม บรรจุในกระบวนการใหม่ และตรวจสอบตัวตนก่อนเจาะ การส่งซ้ําได้เอาผู้สมัครรายเดียวกันมา ได้รับการยืนยันว่านําใบเสร็จมาคืนโดยไม่มีใบรับรอง ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentHandoffProof
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}การตอบโต้
200 กู้เจ้าของที่อนุมัติ API กุญแจ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
ยืนยันการติดตั้งคีย์ของเจ้าของ
ผู้โทรต้องได้บันทึกผู้สมัครไว้แล้ว และตรวจสอบให้เป็นอิสระในขั้นตอนที่สดใหม่ Comment=ลบเครื่องหมาย ACK ที่ถูกติดตั้งแล้วออก และลบเนื้อหาที่เชื่อถือได้ออกไป ย้ําว่า ปัง เป็นการกระทําที่ไร้ขอบเขต ไม่มีการยอมรับพารามิเตอร์สําหรับสอบถาม การตอบโต้ไม่รุนแรง เส้นทางตัวแทนเท่านั้นจัดการและคุณสมบัติเปิด; การใช้งานสามารถกลับ 404 เมื่อปิดการทํางาน X-API-Key ถูกห้ามใช้เส้นทางของตัวแทน
การตรวจสอบสิทธิ์: agentHandoffProof
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
connectionId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}การตอบโต้
200 ยืนยันการติดตั้งคีย์ของเจ้าของ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
400 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
429 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 คํา ขอ ที่ ไม่ ได้ รับ คํา สั่ง; ตรวจ สอบ รหัส ปัญหา. อย่าสร้างการกลายพันธุ์แบบไม่รู้จบ
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}แคตตาล็อก
GET/catalog/sources
รายการความสามารถของแหล่งสาธารณะโดยไม่ต้องกําหนดค่าตัวเลขสําหรับบัญชีผู้ใช้
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 แคตตาล็อกแหล่งสาธารณะ
ส่วนหัว: Cache-Control
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
รายการสาธารณะ USD ผังและราคา
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 แคตตาล็อกแผนสาธารณะ
ส่วนหัว: Cache-Control
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
โปรดอ่านสัญญาและรุ่นปริยายที่ต้องการสําหรับการเซ็น
การตรวจสอบสิทธิ์: สาธารณะ
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 แคตตาล็อกเวอร์ชันของกฎหมายในปัจจุบัน
ส่วนหัว: Cache-Control
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
อ่านการบอกรับข้อมูล root ที่มีประสิทธิภาพ
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 การสมัครสมาชิกหรือ PAYG การกําหนดชื่อ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
สร้างกลุ่มงานแบบถอดไพ่
Internations และเผยแพร่แพ็คเครดิตใช้ priceId การใช้ส่วนบนกําหนดเอง amountMinor แทน (USD เซ็นต์, บาท10 ถึง $999,999.99เครื่องแม่ข่ายคํานวณเครดิต ที่มูลค่าเครดิตคงที่ และสร้างราคาส่วนตัว ครั้งเดียว Poduct, ราคาผู้ให้บริการ, สกุลเงิน, ความสําเร็จ URL และยกเลิก URL ไม่เคยได้รับการตอบรับจากเบราว์เซอร์ เงิน ที่ ได้ จาก การ ตรวจ สอบ จํานวน นี้ จะ ได้ รับ หลัง จาก ที่ ได้ รับ เงิน เดือน แล้ว.
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ต้องการ
ชุดรูปแบบ · 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"
}
}
}
]
}การตอบโต้
201 วาระงานการเช็คเอาต์
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 ผู้ให้บริการแบบทบต้นล้มเหลว
502 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ได้รับการปรับแต่งจากแคตตาล็อกการเรียกเก็บเงินหรือผู้ให้บริการ หรือไม่สามารถใช้งานชั่วคราวได้
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
ปรับรุ่นรายการย่อยปัจจุบันเป็นราคาที่สูงขึ้น
เครื่องแม่ข่ายตรวจสอบว่า FlashData ราคายังใช้งานอยู่ ที่มีอยู่ในไลฟ์โมเดลปัจจุบัน USD- ลดลง เกิดขึ้นอีก ช่วงเดียวกัน และแพงกว่าราคาสมาชิกในปัจจุบัน Product, price, เงินตราและตัวเลือกการดําเนินงาน ไม่เคยเป็นที่ยอมรับจากเบราว์เซอร์ การกําหนดชื่อและเครดิตในท้องถิ่นมีการเปลี่ยนแปลง หลังจากมีการสร้างเหตุการณ์ขึ้น
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}การตอบโต้
201 การเปลี่ยนชื่อ
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 ผู้ให้บริการแบบทบต้นล้มเหลว
502 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ได้รับการปรับแต่งจากแคตตาล็อกการเรียกเก็บเงินหรือผู้ให้บริการ หรือไม่สามารถใช้งานชั่วคราวได้
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
สร้างวาระการใช้งานพอร์ตของลูกค้า
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}การตอบโต้
201 วาระการใช้งานพอร์ตของลูกค้า
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 ผู้ให้บริการแบบทบต้นล้มเหลว
502 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ได้รับการปรับแต่งจากแคตตาล็อกการเรียกเก็บเงินหรือผู้ให้บริการ หรือไม่สามารถใช้งานชั่วคราวได้
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
กําหนดการหรือยกเลิกการบอกรับจดหมายที่จ่ายอยู่ในปัจจุบัน
ตั้งค่า cancelAtPeriodEnd ถึง true กําหนดการยกเลิกเมื่อสิ้นสุดการเรียกเก็บค่าปัจจุบัน false เก็บรายชื่อไว้ การปรับปรุงรายการภายหลังเหตุการณ์การบอกรับข้อมูลแบบตรวจสอบแล้ว จุดปลายนี้ไม่เคยยกเลิกทันที หรือประเด็นการคืนเงิน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}การตอบโต้
202 การปรับปรุงการยกเลิกจดหมายที่ส่งไปยัง root
202 ตอบกลับ · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 ผู้ให้บริการแบบทบต้นล้มเหลว
502 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ได้รับการปรับแต่งจากแคตตาล็อกการเรียกเก็บเงินหรือผู้ให้บริการ หรือไม่สามารถใช้งานชั่วคราวได้
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
รายการที่ตัดมาในรูปแบบใบแจ้งหนี้
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
cursor · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"maxLength": 512
}limit · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}การตอบโต้
200 ใบแจ้งหนี้
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
รายการบัญชีที่คัดลอกขึ้นบนและคํานวณการจ่ายเงินคืน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
cursor · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"maxLength": 512
}limit · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}การตอบโต้
200 ประวัติการชําระเงินหนึ่งครั้งโดยไม่มีความลับของผู้ให้บริการ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}เครดิต
GET/api-access/balance
อ่านบัญชีที่ใช้ได้โดยใช้ API กุญแจ
อ่านค่าสมดุลของเครดิตในปัจจุบันที่ทุกคนแบ่งปัน API กุญแจในบัญชีของคุณ การจองที่ทํางานอยู่ สามารถลดดุลยภาพที่มีอยู่ได้ การ ขอ เช่น นี้ ไม่ มี ค่า สินสอด และ ไม่ ต้อง รับ พารามิเตอร์ หรือ ร่าง กาย. การตอบสนองเป็นส่วนบุคคล และไม่ได้ถูกจัดเก็บเอาไว้; อัตราการอ่านบัญชีจะปรับใช้
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 เงิน ที่ ได้ จาก การ ลง นาม ใน บัญชี ธนาคาร และ ไม่ มี ราย ได้ ที่ เสีย หาย
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อ่านบัญชีผู้ใช้มากเกินไป; ลองใหม่หลังจากอ่านหน้าต่างที่มีอัตรา- ระดับ
503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
อ่านค่าบัญชีจริงสําหรับแหล่งที่ได้รับอนุญาตโดย API กุญแจ
อ่านอัตราดอกเบี้ยบัญชีของคุณสําหรับแหล่งที่อนุญาต API กุญแจ A null ราคาหมายถึง แหล่งนั้นไม่มี request_count จํานวน quiries, ไม่ใช่รายการที่ส่งกลับมา; อัตราการดาวน์โหลดต่อ ทีบี (ค.ศ.10^12 ไบต์) การ กะ ประมาณ ไม่ ได้ สงวน ทรัพย์ สิน หรือ ความ สามารถ ไว้. คํา ขอ นี้ ไม่ มี ค่า สิน เชื่อ. การตอบสนองเป็นส่วนบุคคล และไม่ได้ถูกจัดเก็บเอาไว้; อัตราการอ่านบัญชีจะปรับใช้
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
source · query · ตัวเลือก
แหล่ง ที่ ให้ ไว้ สําหรับ กุญแจ นี้; ต้องการ อ่าน แหล่ง ข้อมูล ที่ ได้ รับ ทุก อย่าง.
ชุดรูปแบบ
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · ตัวเลือก
จํานวนหมายเลขจํานวนเต็มที่น้อยที่สุด; ไม่ได้ประมาณขนาดดาวน์โหลด
ชุดรูปแบบ
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}การตอบโต้
200 ผังบัญชีผู้ใช้และราคาที่ระบุแหล่ง
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อ่านบัญชีผู้ใช้มากเกินไป; ลองใหม่หลังจากอ่านหน้าต่างที่มีอัตรา- ระดับ
503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
อ่านแผนจํากัดบัญชีและงานที่ค้างคาในปัจจุบันโดยใช้ API กุญแจ
อ่านค่าความสอดคล้องของคุณ, ขนาดของกลุ่ม และขอบเขตการทํางาน รวมไปถึงจํานวนที่รองานอยู่ปัจจุบันด้วย ค่าเหล่านี้จะช่วยให้แผนร้องขอ แต่ไม่สามารถสงวนความจุได้ การ ขอ เช่น นี้ ไม่ มี ค่า สินสอด และ ไม่ ต้อง รับ พารามิเตอร์ หรือ ร่าง กาย. การตอบสนองเป็นส่วนบุคคล และไม่ได้ถูกจัดเก็บเอาไว้; อัตราการอ่านบัญชีจะปรับใช้
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 วางแผนเพดานและนับระยะการรอการทํางานปัจจุบัน
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อ่านบัญชีผู้ใช้มากเกินไป; ลองใหม่หลังจากอ่านหน้าต่างที่มีอัตรา- ระดับ
503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
อ่านค่าการใช้บัญชีผู้ใช้สําหรับแหล่งที่อนุญาต API กุญแจ
อ่านได้ฟรี โดยยืนยันโดย X-API-Key. รวมกุญแจบัญชีผู้ใช้ทั้งหมด แต่ แหล่งข่าวเฉพาะกุญแจเท่านั้น ไม่ตอบกลับข้อความสําหรับสอบถาม, กุญแจ รายละเอียดการจ่ายเงินหรือบัญชีอื่น ๆ ค่าปริยายของ 7 วัน; ค่าสูงสุด 31 วัน. วันที่จะต้องใช้ UTC Z timetamps จากความเป็นหนึ่งเดียว และเป็นการรวมเอา ทั้งสองวงถูกล้อมรอบไปนาที ด้วยจากเพียงอย่างเดียวไปใช้ค่าปริยายเป็น + 7 วัน ทั้ง ๆ ที่ ไม่ ได้ เป็น จุด เริ่ม ต้น ของ นาที ถัด ไป. ใน ที่ สุด ก็ มี การ แบ่ง แยก สอดคล้องกัน แม้แต่การปรับปรุง = false ไม่ได้รับการรับประกันว่า เหตุการณ์ล่าสุดทั้งหมดถูกกลืนเข้าไป จํากัดการอ่าน: 60 ขอต่อนาทีต่อลูกค้ารายที่ IP
การตรวจสอบสิทธิ์: dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
source · query · ตัวเลือก
แคตตาล็อกที่แน่นอนที่ให้กับคีย์เรียก; การละทิ้งหมายถึงทั้งหมดให้แหล่ง
ชุดรูปแบบ
{
"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 · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"format": "date-time"
}to · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"format": "date-time"
}การตอบโต้
200 การ ขอ ที่ ถูก สํารวจ นับ และ คิด ค่า สิน เชื่อ ด้วย ข้อมูล ใหม่ ๆ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 อ่านค่าการใช้งานมากเกินไป; ทําการปรับปรุงหน้าต่างหลังจากการลดความเร็วเสียง
503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
อ่านค่าเครดิตปัจจุบันและสงวน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ความ สมดุล ที่ ได้ มา
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
อ่านนโยบายการให้เครดิตและค่าใช้จ่ายที่มีประสิทธิภาพ
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 ข้อกําหนดการให้เครดิตที่มีประสิทธิภาพ
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
รายการบัญชีเครดิต
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
cursor · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"maxLength": 512
}limit · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · ตัวเลือก
ชุดรูปแบบ
{
"$ref": "#/components/schemas/CreditEntryType"
}การตอบโต้
200 รายการของ Ledger
200 ตอบกลับ · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}เครดิตแบบทดสอบ
GET/trial-credit-request
อ่านการตรวจสอบเครดิตความเหมาะสมและคําขอการใช้งานของบัญชี
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 การกําหนดความง่ายในปัจจุบัน, การให้แบบปรับแต่ง, และสถานะที่ต้องการ
ส่วนหัว: Cache-Control
200 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
ส่วนหัว: Cache-Control, X-Request-Id
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ มี การ ติด ต่อ กับ บุคคล ใด ๆ หรือ ไม่ มี แผ่น เสียง บน เครื่อง บิน นี้ อยู่ ชั่ว คราว
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
ส่งใบเรียกเก็บเงินตลอดชีวิต
การ พิจารณา คดี จะ มี มาก และ จะ ช่วย ให้ รอด เมื่อ คุณ ยื่น คํา ร้อง ขอ.
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Idempotency-Key · header · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 255
}ขอตัว · ตัวเลือก
ชุดรูปแบบ · application/json
{
"type": "object",
"additionalProperties": false
}การตอบโต้
201 การตรวจสอบการร้องขอจากแหล่งเก็บอีเมลที่ได้สร้างและมีการอนุมัติโดยอัตโนมัติ สําหรับบัญชีผู้ใช้ที่ได้รับการยืนยันแล้ว ไม่ว่าผู้ให้บริการอีเมลจะให้บริการหรือไม่
ส่วนหัว: Cache-Control
201 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
ส่วนหัว: Cache-Control, X-Request-Id
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 ได้รับการยืนยันแต่ไม่ได้รับอนุญาตหรือ CSRF การตรวจสอบสิทธิ์ล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
403 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
ส่วนหัว: Cache-Control, X-Request-Id
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
ส่วนหัว: Cache-Control, X-Request-Id
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 เกิดข้อผิดพลาดภายในที่ไม่คาดคิดขึ้น
ส่วนหัว: Cache-Control, X-Request-Id
500 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่ มี การ ติด ต่อ กับ บุคคล ใด ๆ หรือ ไม่ มี แผ่น เสียง บน เครื่อง บิน นี้ อยู่ ชั่ว คราว
ส่วนหัว: Cache-Control, X-Request-Id
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}ส่งแล้ว
GET/delivery/webhooks
รายการที่บันทึกการเรียกเสร็จสิ้น URLs
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
การตอบโต้
200 เรียกกลับ URLs
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
จัดเก็บการเรียกกลับแบบสมบูรณ์ URL
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}การตอบโต้
201 สร้างเมื่อ
201 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
ลบการเรียกให้เสร็จสิ้น URL
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
webhookId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}การตอบโต้
204 ลบแล้ว
401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
ส่งข้อมูลที่ดาวน์โหลดมาแล้วที่สมบูรณ์
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
webhookId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}การตอบโต้
200 ทดสอบ
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}งาน
สําหรับการยอม อ่อนน้อม, สถานะและตัวอย่างผลลัพธ์ ดู Realtime และ async · คำขอแบบ batch.
GET/jobs
รายการข้อมูล API งานพิมพ์ปัจจุบัน
ประวัติที่แอ็กทีฟและจัดเก็บของเคอร์เซอร์ ค่าปริยายคือ 7 วันหลัง; แต่ละช่วงวันที่ UTC จะถูกจํากัดให้เหลือ 31 วัน. จากนี้เป็นการรวมกันของกลุ่มต่างๆ และมีความแม่นยําในนาทีเดียว มี การ รักษา ปริมาณ การ กิน ไว้ อย่าง ไม่ หยุด ยั้ง และ อาจ กิน น้อย ลง.
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
cursor · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"format": "date-time"
}to · query · ตัวเลือก
ชุดรูปแบบ
{
"type": "string",
"format": "date-time"
}การตอบโต้
200 หน้างาน
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 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
อ่านข้อมูลหนึ่ง API งาน
อ่าน job.status เพื่อตรวจสอบความคืบหน้าและ job.error หากการประมวลผลล้มเหลว JSON เป็นค่าปริยาย; ใช้ Accept: text/plain สําหรับข้อความอ่านได้ X-Respond-With ถูกทอดทิ้งที่นี่ ติดตาม Retry-After เมื่อมีให้ก่อนการตรวจสอบอีกครั้ง
การตรวจสอบสิทธิ์: cookieSession หรือ dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
Accept · header · ตัวเลือก
application/json ฟังก์ชัน CHAR () จะคืนค่าเป็นอักขระที่มีรหัสตัวเลขตรงกับที่กําหนด text/plain กลับเป็นช่องข้อมูลเดียวกันกับข้อความธรรมดาที่สะกดไม่ได้ รองรับสื่อมาตรฐานและน้ําหนัก q; ขาด Accept หรือไวล์การ์ดทั่วโลก จะเลือกใช้ JSON. X-Respond-With ไม่สนใจการส่งข้อมูล และงาน-status ปลายจุด ข้อผิดพลาดยังคงมีโครงสร้างแบบ JSON ใช้ชนิดการตอบสนองทั้งคู่ UTF-8สืบค้นเมื่อ:8 รองรับพารามิเตอร์
ชุดรูปแบบ
{
"type": "string"
}jobId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}การตอบโต้
200 รายละเอียดงาน
200 ตอบกลับ · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}200 ตอบกลับ · text/plain
{
"type": "string"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 ไม่ทั้งคู่ application/json และไม่ text/plain เป็นที่ยอมรับได้; การตอบสนองคือ JSON
406 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
ดาวน์โหลดผลลัพธ์ aync เสร็จสมบูรณ์
โดยค่าเริ่มต้น ระบบตรวจสอบสิทธิ์แล้วเปลี่ยนเส้นทางไปยัง URL ส่วนตัวของ R2 ที่มีอายุสั้น ไคลเอนต์รับ JSON เดิมจาก R2 โดยตรง Accept: text/plain จะคืน HTTP 200 พร้อมฟิลด์ผลลัพธ์เดิมในรูปข้อความธรรมดาที่จัดย่อหน้า X-Respond-With: markdown เลือกเนื้อหา Markdown โดย application/json ใส่เนื้อหาใน content แทน results และคง metadata เดิม ส่วน text/plain คืน metadata ตามด้วย Markdown หากไม่ระบุ Accept หรือใช้ wildcard ทั้งหมด จะใช้ JSON การเปลี่ยนรูปแบบไม่ได้ส่งคำขอค้นหาใหม่หรือคิดเครดิตเพิ่ม ผลลัพธ์ที่บันทึกไว้หมดอายุ 24 ชั่วโมงหลังเสร็จสิ้น ข้อผิดพลาดยังเป็น JSON แบบมีโครงสร้าง
การตรวจสอบสิทธิ์: cookieSession หรือ dataApiKey
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
X-Respond-With · header · ตัวเลือก
ตั้งค่าที่จะทําเครื่องหมายลงเพื่อกลับค่าเนื้อหาเป็น Markdown. การรักษาสนามผลิตผลเดิมไว้ Accept เลือกแบบอิสระ JSON หรือข้อความธรรมดา การอ่านผลงานพิมพ์ที่เสร็จสมบูรณ์ จะเป็นการรองรับส่วนส่วนหัวนี้เท่านั้น มันไม่ได้เปลี่ยนการส่งข้อมูลงาน, สถานะ, บัญชี APIs, การเรียกกลับ Bulk แฟ้ม, ดาวน์โหลดไบนารี หรือ MCP การตอบสนองตามระเบียบ
ชุดรูปแบบ
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · ตัวเลือก
เลือก application/json หรือ text/plain เป็นอิสระจาก X-Respond-With. # หากไม่มี X-Respond-With, text/plain กลับค่าเดิมเป็นระยะเยื้อง JSON คงพื้นที่เดิมสําหรับการตอบสนองไว้ (อ่านค่าเปลี่ยนเส้นทางไปยังคลัง) ด้วยสัญลักษณ์ JSON ฟังก์ชัน CHAR () จะคืนค่าเป็นอักขระที่มีรหัสตัวเลขตรงกับที่กําหนด Markdown. รองรับสื่อมาตรฐานและน้ําหนัก q; ขาด Accept หรือไวล์การ์ดทั่วโลก จะเลือกใช้ JSON. ใช้ชนิดการตอบสนองทั้งคู่ UTF-8สืบค้นเมื่อ:8 รองรับพารามิเตอร์
ชุดรูปแบบ
{
"type": "string"
}jobId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}การตอบโต้
200 ช่องข้อมูลธรรมดาหรือ Markdown กลับโดยตรง; เดิม JSON จาก R2 หลังการสลับรูปแบบปริยาย
200 ตอบกลับ · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}200 ตอบกลับ · text/plain
{
"type": "string"
}302 กลับไปยังต้นฉบับ JSON เป็นการส่วนตัว R2 จัดเก็บเมื่อ JSON ถูกเลือกโดยไม่เลือก X-Respond-With
ส่วนหัว: Location
400 ไม่สนับสนุน X-Respond-With ค่า; การตอบสนอง JSON
400 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 ไม่ทั้งคู่ application/json และไม่ text/plain เป็นที่ยอมรับได้; การตอบสนองคือ JSON
406 ตอบกลับ · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 ผลการหมดอายุ
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 งานล้มเหลว หากมีการบันทึกสาเหตุของความล้มเหลวไว้ การตอบกลับจะระบุสาเหตุในฟิลด์ detail
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API ประมวลผล Bulk
Bulk points มีเนื้อหาที่อุทิศให้กับพารามิเตอร์, ร้องขอตัวอย่างและการตอบสนอง Shems เปิด Bulk การประมวลผล API
GET /v2/bulk-jobs· รายการขนาด YouTube งานPOST /v2/bulk-jobs· สร้างรายการ Bulk ทํางานและได้รับการอัปโหลดแฟ้ม URLGET /v2/bulk-jobs/{bulkId}· อ่านงานจํานวนมากและนับรวมPATCH /v2/bulk-jobs/{bulkId}· เปลี่ยนการตั้งค่าของวีดิทัศน์ที่ยังไม่ได้เริ่มการทํางานDELETE /v2/bulk-jobs/{bulkId}· ยกเลิก Bulk งานPOST /v2/bulk-jobs/{bulkId}/start· เริ่มสแกนการอัปโหลด YouTube ID แฟ้มPOST /v2/bulk-jobs/{bulkId}/pause· หยุดชั่วคราว Bulk งานPOST /v2/bulk-jobs/{bulkId}/resume· ทํางานใหญ่หรือหยุดงานชั่วคราวด้วยตนเอง หรือโดยอัตโนมัติGET /v2/bulk-jobs/{bulkId}/results· ดาวน์โหลดรายการที่แสดงทั้งหมดเรียบร้อยแล้วGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· ดาวน์โหลดส่วนผลลัพธ์ที่มากมายของ gzip-compression NDJSON
ที่เล่น
POST/playground/run
ประมวลผลข้อมูล IPTC เป็นพื้นที่การทํางานปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession + csrfToken
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
ขอตัว · ต้องการ
ชุดรูปแบบ · 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
}
}
}การตอบโต้
200 ข้อมูลระดับบน API การ ตอบ รับ ของ สนามเด็กเล่น
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 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 การร้องขอการตรวจสอบสิทธิ์ล้มเหลว
422 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
ดาวน์โหลดสิ่งประดิษฐ์ที่แปลงเป็นเพลย์เฟิลเสร็จสมบูรณ์ในเบราว์เซอร์ปัจจุบัน
การตรวจสอบสิทธิ์: cookieSession
เซิร์ฟเวอร์: https://api.flashdata.dev/v2
เซิร์ฟเวอร์: http://localhost:5000/v2
พารามิเตอร์
jobId · path · ต้องการ
ชุดรูปแบบ
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}การตอบโต้
200 สิ่งประดิษฐ์สําหรับเรียกใช้งานชั่วคราว
ส่วนหัว: Content-Disposition, Content-Length
200 ตอบกลับ · application/octet-stream
{
"type": "string",
"format": "binary"
}401 ต้องการการตรวจสอบสิทธิ์หรือไม่?
401 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 ไม่พบทรัพยากรหรือไม่ได้เป็นเจ้าของโดยผู้เรียก
404 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 ความขัดแย้งของสถานะทรัพยากรหรือความไม่เข้มงวด
409 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 สิ่งประดิษฐ์ชั่วคราวหมดอายุแล้ว
410 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 ไม่สามารถเชื่อมโยงหรือแคตตาล็อกที่ต้องการได้ชั่วคราว
503 ตอบกลับ · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}นิยามการสลับรูปแบบ
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."
}
}
}