दस्तावेज़ देखें
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'Expected HTTP 200 to success. प्रत्येक समापन बिंदु की प्रमाणीकरण लाइन की जाँच करें: dataApiKey X-API-Key का उपयोग करता है; cookieSession एक हस्ताक्षरित ब्राउज़र सत्र का उपयोग करता है। पहचान प्रतिक्रिया स्कीमा
ग्राहक OpenAPI विनिर्देश डाउनलोड करें. इसमें प्रश्नों, नौकरियों, खातों, API कुंजी और बिलिंग शामिल हैं।
क्वेरी पैरामीटर और अनुरोध कोड में दस्तावेज किए जाते हैं Google और YouTube API संदर्भ
प्रमाणीकरण योजना
| योजना | आवश्यकता |
|---|---|
dataApiKey |
FlashData API कुंजी। नौकरी का उपयोग कुंजी के स्रोत दायरे तक सीमित है। |
cookieSession |
वेब सत्र। ब्राउज़र इस कुकी को नहीं पढ़ सकता है। |
csrfToken |
apiKey |
agentRegistrationProof | Persist एक क्रिप्टोग्राफिक यादृच्छिक 32-byte base64url सबूत और सटीक अनुरोध BeFORE भेजने; केवल उसी प्रमाण और शरीर के साथ ठीक हो जाओ। एक 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}
एक एप्लिकेशन प्राधिकरण अनुरोध पढ़ें और इसे वर्तमान सत्र में बांधें
पूर्ण सत्र की आवश्यकता होती है। अनुरोध दस मिनट के बाद समाप्त हो जाता है। प्रतिक्रिया कोई स्टोर नहीं है।
प्रमाणीकरण: 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
एक अपारदर्शी वेब सत्र बनाएँ
सुरक्षित, HttpOnly `__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
ई-मेल सत्यापन संदेश का अनुरोध या उसे पुनः भेजना
प्रत्येक syntactically मान्य ईमेल के लिए, उसी प्रतिक्रिया को लौटाता है चाहे वह खाता गायब हो, लंबित, सक्रिय, निलंबित या हटा दिया गया हो। योग्य लंबित खातों को पुनर्विक्रय करने के बाद एक बार का लिंक प्राप्त होता है।
प्रमाणीकरण: सार्वजनिक
सर्वर: 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 टोकन लाइव पासवर्ड-authenticated ईमेल सत्यापन सत्र के लिए बाध्य है। जब तक कि सत्र का अपना खाता सत्यापित नहीं किया जाता है तब तक लंबित रिटर्न, जिसमें किसी अन्य ब्राउज़र में सत्यापन भी शामिल है। एटॉमिक रूप से साइनअप सत्र को रद्द कर देता है और एक नया पूर्ण या कानूनी स्वीकृति सत्र जारी करता है। एक खाता नहीं स्वीकार करता है 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
पासवर्ड रीसेट ईमेल का अनुरोध करें
हमेशा खाता अस्तित्व या lifecycle राज्य की परवाह किए बिना एक syntactically मान्य ईमेल के लिए एक ही 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
एक नया पासवर्ड सेट करें और मौजूदा सत्रों को रद्द करें
एटॉमिक रूप से पासवर्ड रीसेट टोकन का उपभोग करता है, एक नया Argon2id क्रेडेंशियल स्टोर करता है, हर मौजूदा सत्र को रद्द करता है, और अन्य पासवर्ड रीसेट टोकनों को अमान्य करता है। यह उपयोगकर्ता को एक सत्र में लॉग इन या नहीं करता है।
प्रमाणीकरण: सार्वजनिक
सर्वर: 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
एक संवेदनशील ऑपरेशन के लिए वर्तमान पासवर्ड को सत्यापित करें
वर्तमान सर्वर-साइड सत्र पर एक अल्पकालिक हालिया-auth सबूत रिकॉर्ड करता है।
प्रमाणीकरण: 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 सीमा है। समवर्ती प्रमाणित कार्यक्रम उसी अनुरोध को वापस करते हैं। सत्र के पुनरीक्षण के बाद, deletion_recovery मोड में लॉग इन करके और GET /account/deletion को पढ़ने से एक खोई हुई प्रतिक्रिया ठीक हो जाती है; फिर से शुरू होने वाले सत्रों को फिर से खेलने के लिए कभी स्वीकार नहीं किया जाता है।
प्रमाणीकरण: 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 Deletion अनुसूचित; सक्रिय सत्र और चाबियाँ रद्द
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
अनुग्रह अवधि के दौरान एक निर्धारित विलोपन को रद्द करना
एक अनुसूचित से cancelled तुलना और सेट का उपयोग करता है। एक प्रोसेसर रेस रिटर्न 409; सफलता के बाद वसूली सत्र को घुमाया जाता है और पुराने संक्रमण को फिर से नहीं चला सकता है।
प्रमाणीकरण: 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
Resumable 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-key read. सार्वजनिक वापसी 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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 बनाया गया; वही idempotent फिर से खेलना पांच मिनट के लिए उसी एन्क्रिप्टेड प्रतिक्रिया को वापस कर सकता है।
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 भविष्य में होना चाहिए, सात दिनों के भीतर, और बाद में पुरानी कुंजी एक्सपेरी से नहीं।
प्रमाणीकरण: 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 प्रमाणीकरण। रिटर्न केवल सार्वजनिक प्रदान किया गया स्रोत नाम और कॉन्फ़िगर किए गए हस्ताक्षरित-result भंडारण मूल (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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
503 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
एक अस्थायी APIQ-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 एक अस्थायी APIQ-key कनेक्शन बनाएं या पुनर्प्राप्त करें
201 प्रतिक्रिया · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
503 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
ब्राउजर अप्रूवल दावा
एक विश्वसनीय FlashData वेब मूल पर claimPath खोलें और कोड को अलग से प्रदर्शित करें। कभी भी क्रेडेंशियल या 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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
503 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
अनुमोदित मालिक API कुंजी को पुनर्प्राप्त करें
कैंडिडेट की स्थापना ACK तक 24 घंटों में समाप्त हो जाती है। पर्सिस्ट परमाणु रूप से, एक नई प्रक्रिया में पुनः लोड हो जाता है और 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": {},
"required": []
}जवाब
200 अनुमोदित मालिक API कुंजी को पुनर्प्राप्त करें
200 प्रतिक्रिया · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
503 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Acknowledge सत्यापित मालिक कुंजी स्थापना
कॉलर ने पहले से ही उम्मीदवार को बचाया है और स्वतंत्र रूप से इसे एक ताजा प्रक्रिया में सत्यापित किया है। सफल ACK अंक स्थापित, उम्मीदवार कुंजी समाप्ति को हटा देता है और पुनर्प्राप्त करने योग्य क्रेडेंशियल सामग्री को हटा देता है। दोहराया ACK idempotent है। कोई प्रश्न पैरामीटर स्वीकार नहीं किए जाते हैं। प्रतिक्रियाएं कोई स्टोर नहीं हैं। एजेंट मार्ग प्रबंधन-केवल और फीचर-गेटेड हैं; तैनाती अक्षम होने पर 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 Acknowledge सत्यापित मालिक कुंजी स्थापना
200 प्रतिक्रिया · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
400 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
401 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
403 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
409 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
410 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
422 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
429 प्रतिक्रिया · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; समस्या कोड का निरीक्षण करें। कभी भी किसी भी तरह के बदलाव को अंधे नहीं करते।
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
प्रभावी स्ट्रिप सदस्यता पढ़ें
प्रमाणीकरण: 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
एक स्ट्रिप-होस्टेड चेकआउट सत्र बनाएँ
सदस्यता और प्रकाशित क्रेडिट पैक priceId का उपयोग करते हैं। एक कस्टम टॉप-अप इसके बजाय amountMinor (USD सेंट्स, $10 से $999,999.99); सर्वर निश्चित क्रेडिट मान पर क्रेडिट की गणना करता है और एक निजी एक बार स्ट्रिप मूल्य बनाता है। उत्पाद, प्रदाता मूल्य, मुद्रा, सफलता 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-denominated, आवर्ती, एक ही अंतराल, और वर्तमान सदस्यता मूल्य की तुलना में सख्ती से अधिक महंगा है। उत्पाद, प्रदाता की कीमत, मुद्रा और प्रोरेशन विकल्प कभी ब्राउज़र से स्वीकार नहीं किए जाते हैं। स्थानीय पात्रता और क्रेडिट केवल एक सत्यापित प्रदाता घटना के बाद ही बदल जाते हैं।
प्रमाणीकरण: 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 रद्दीकरण अद्यतन स्ट्राइप को प्रस्तुत
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 कुंजी द्वारा अनुमत स्रोतों के लिए अपनी खाता दरें पढ़ें। एक null मूल्य का मतलब है कि स्रोत अनुपलब्ध है। request_count प्रश्नों की गिनती नहीं करता है; डाउनलोड दरें प्रति टीबी (10^12 बाइट्स) हैं। अनुमान क्रेडिट या क्षमता आरक्षित नहीं है। इस अनुरोध पर कोई क्रेडिट खर्च नहीं होता है। उत्तर निजी हैं और कैश नहीं हैं; खाता पढ़ने की दर सीमा लागू होती है।
प्रमाणीकरण: dataApiKey
सर्वर: https://api.flashdata.dev/v2
सर्वर: http://localhost:5000/v2
पैरामीटर
source · query · वैकल्पिक
इस कुंजी को दिए गए स्रोत; सभी दिए गए स्रोतों को पढ़ने के लिए मत भूलना।
शिमा
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · वैकल्पिक
Decimal integer कॉल की संख्या; डाउनलोड आकार का अनुमान नहीं है।
शिमा
{
"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 द्वारा प्रमाणित। इसमें सभी खाता कुंजी शामिल है लेकिन केवल कॉलिंग कुंजी के लिए दिए गए स्रोतों। क्वेरी टेक्स्ट, कुंजियों को वापस नहीं करता है, भुगतान विवरण या अन्य खाते। डिफ़ॉल्ट सात दिनों के लिए; अधिकतम 31 दिन। तारीखों को यूटीसी जेड टाइमटाम्प्स का उपयोग करना चाहिए। से शामिल है और अनन्य करने के लिए; दोनों को मिनट तक गोल किया जाता है। अकेले से चूक करने के लिए + 7 दिनों से। न तो, अगले मिनट की शुरुआत है। अंत में कुलीन सुसंगत; यहां तक कि अद्यतन = false गारंटी नहीं देता है कि हाल के सभी घटनाओं को ingested किया गया है। पढ़ें सीमा: 60 अनुरोध प्रति मिनट ग्राहक IP।
प्रमाणीकरण: dataApiKey
सर्वर: https://api.flashdata.dev/v2
सर्वर: http://localhost:5000/v2
पैरामीटर
source · query · वैकल्पिक
एक सटीक सूची स्रोत जिसे कॉलिंग कुंजी को दिया जाता है; omitted मतलब सभी स्रोतों को दिया जाता है।
शिमा
{
"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 लेजर प्रविष्टियों
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
Read Trial credit पात्रता और खाते के जीवनकाल अनुरोध
प्रमाणीकरण: 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 नौकरियां
Cursor-paginated सक्रिय और संग्रहीत इतिहास। पिछले सात दिनों में डिफ़ॉल्ट; प्रत्येक UTC की तारीख सीमा 31 दिनों तक सीमित है। से शामिल है और करने के लिए विशेष है, मिनट परिशुद्धता पर। सारांश को अतुल्यकालिक रूप से बनाए रखा जाता है और लैग ingestion हो सकता है।
प्रमाणीकरण: 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 मूल संरचित प्रतिक्रिया देता है; text/plain एक ही क्षेत्र को इंडेंटेड सादे टेक्स्ट के रूप में लौटाता है। मानक मीडिया रेंज और q भार समर्थित हैं; Accept या JSON को वैश्विक वाइल्डकार्ड डिफ़ॉल्ट रूप से गायब हो गया। X-Respond-With को जमा करने और नौकरी-स्टेटस समापन बिंदुओं पर नजरअंदाज कर दिया गया है। त्रुटियां संरचित JSON बनी हुई हैं। दोनों प्रतिक्रिया प्रकार UTF-8 का उपयोग करते हैं; एक स्पष्ट वर्णक्रम = utf-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
पूर्ण async परिणाम डाउनलोड करें
डिफ़ॉल्ट रूप से, एक अल्पकालिक निजी R2 URL को एक्सेस और रीडायरेक्ट करता है; ग्राहकों को सीधे R2 से मूल JSON प्राप्त होता है। Accept: text/plain स्वतंत्र रूप से मूल परिणाम फ़ील्ड के साथ HTTP 200 लौटाता है। X-Respond-With: मार्कडाउन Markdown सामग्री का चयन करता है: application/json इसे मूल मेटाडाटा के साथ सामग्री में लपेटता है, परिणाम की जगह लेता है; text/plain रिटर्न मेटाडाटा उसके बाद Markdown द्वारा होता है। लापता Accept या JSON को वैश्विक वाइल्डकार्ड डिफ़ॉल्ट। प्रारूपण किसी अन्य क्वेरी या शुल्क क्वेरी क्रेडिट को जमा नहीं करता है। स्टोर किए गए परिणाम पूरा होने के बाद 24 घंटे समाप्त हो जाते हैं। त्रुटियां संरचित JSON बनी हुई हैं।
प्रमाणीकरण: cookieSession या dataApiKey
सर्वर: https://api.flashdata.dev/v2
सर्वर: http://localhost:5000/v2
पैरामीटर
X-Respond-With · header · वैकल्पिक
परिणाम सामग्री को Markdown के रूप में वापस करने के लिए मार्कडाउन सेट करें। मूल परिणाम फ़ील्ड को बनाए रखने के लिए ओमित करें। Accept स्वतंत्र रूप से JSON या सादे पाठ का चयन करता है। केवल वास्तविक समय के प्रश्नों और पूर्ण नौकरी परिणाम इस शीर्षलेख का समर्थन करता है। यह नौकरी प्रस्तुतियों, स्थिति, खाता एपीआई, कॉलबैक, Bulk फ़ाइलों, द्विआधारी डाउनलोड, या MCP प्रोटोकॉल प्रतिक्रियाओं को नहीं बदलता है।
शिमा
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · वैकल्पिक
application/json या text/plain स्वतंत्र रूप से X-Respond-With से चुनें। X-Respond-With के बिना, text/plain इंडेंटेशन के साथ मूल फ़ील्ड लौटाता है; JSON मूल प्रतिक्रिया क्षेत्रों को बरकरार रखता है (पूरी तरह से पढ़ने वाली समीक्षा भंडारण के लिए पुनर्निर्देशित)। मार्कडाउन के साथ, JSON रिटर्न सामग्री प्लस मेटाडाटा और सादे पाठ रिटर्न मेटाडाटा उसके बाद Markdown है। मानक मीडिया रेंज और q भार समर्थित हैं; Accept या JSON को वैश्विक वाइल्डकार्ड डिफ़ॉल्ट रूप से गायब हो गया। दोनों प्रतिक्रिया प्रकार UTF-8 का उपयोग करते हैं; एक स्पष्ट वर्णक्रम = utf-8 पैरामीटर समर्थित है।
शिमा
{
"type": "string"
}jobId · path · आवश्यक
शिमा
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}जवाब
200 सादा पाठ मूल फ़ील्ड या Markdown सीधे वापस आ गया; डिफ़ॉल्ट रीडायरेक्ट के बाद R2 से मूल JSON
200 प्रतिक्रिया · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}200 प्रतिक्रिया · text/plain
{
"type": "string"
}302 जब JSON को X-Respond-With के बिना चुना जाता है, तो निजी R2 संग्रहण में मूल JSON पर रीडायरेक्ट करें
हेडर: Location
400 Unsupported 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"
}Bulk प्रोसेसिंग API
Bulk समापन बिंदुओं में पैरामीटर, अनुरोध उदाहरण और प्रतिक्रिया स्कीमा के साथ एक समर्पित संदर्भ है। ओपन 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· एक uploaded 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-compressed NDJSON बल्क परिणाम भाग डाउनलोड करें
खेल
POST/playground/run
वर्तमान कार्यस्थल के रूप में एक खेल का मैदान क्वेरी चलाएं
प्रमाणीकरण: 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."
}
}
}