Sign inGet Started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

सेल्फ़-सर्व साइनअप

ज़्यादातर एजेंट उस खाते पर चलते हैं जो पहले से आपका है: आप अपना एजेंट सेट अप करते हैं और वह ब्राउज़र के ज़रिए साइन इन करता है। यह गाइड दूसरा रास्ता बताती है, जिसमें बिना खाते वाला एजेंट पूरी तरह टर्मिनल से खुद अपना खाता बनाता है। ईमेल पता सत्यापित करने और संगठन, वर्कस्पेस और क्रेडेंशियल बनाने के लिए CLI या curl का उपयोग करें। लोकल stdio MCP शुरू होने से पहले एक सहेजा हुआ क्रेडेंशियल माँगता है; होस्टेड MCP साइनअप टूल उपलब्ध नहीं कराता। सत्यापन कोड पाने के लिए आपको ईमेल इनबॉक्स तक पहुँच चाहिए। Bird CLI या MCP सर्वर से किए गए साइनअप उसी टूल के नाम दर्ज होते हैं जिसने उन्हें किया।

CLI का उपयोग करें

नीचे दिए गए CLI कमांड के लिए bird CLI इंस्टॉल होना चाहिए। साइनअप और सत्यापन किसी क्षेत्र पर निर्भर नहीं हैं और इनके लिए शुरुआती कॉन्फ़िगरेशन की ज़रूरत नहीं है। आख़िरी चरण में create-org को --region (us1 या eu1) दें, ताकि आप चुन सकें कि खाता और उसका डेटा कहाँ रहे। किसी होस्टनेम या एनवायरनमेंट वेरिएबल की ज़रूरत नहीं है।

1. साइन-इन कोड का अनुरोध करें

bird auth signup छह अंकों का साइन-इन कोड ईमेल करता है। अगर ईमेल पता नया है, तो उस कोड को सत्यापित करने पर खाता बन जाता है। यह डैशबोर्ड वाले ही पासवर्ड-रहित मैजिक-लिंक रास्ते का उपयोग करता है, इसलिए आपको सिर्फ़ ईमेल किया गया कोड चाहिए। अगले चरण के लिए ईमेल पता संभालकर रखें।

कोड उदाहरण
bird auth signup you@example.com
# { "email": "you@example.com", "status": "code_sent" }

2. ईमेल सत्यापित करें

छह अंकों का कोड ईमेल से आता है, यानी CLI के बाहर से: उसे इनबॉक्स से पढ़ें। उसे उसी ईमेल के साथ bird auth verify-email को दें। यह आपको साइन इन करता है और बिल्कुल नए खाते के लिए एक बार इस्तेमाल होने वाला onboarding_ticket लौटाता है।

कोड उदाहरण
bird auth verify-email you@example.com --code 123456
# { "onboarding_ticket": "...", "user_id": "usr_..." }

3. संगठन बनाएँ

bird auth create-org टिकट का उपयोग करके आपका संगठन और वर्कस्पेस बनाता है, फिर नया बना क्रेडेंशियल सहेजता है, ताकि इसके बाद CLI और लोकल stdio MCP सर्वर नए खाते के रूप में प्रमाणित हों। यह एक ही बार चलता है: दूसरी कॉल 409 लौटाती है। --region तय करता है कि खाता और उसका डेटा कहाँ रहे (us1 या eu1) और कॉल को उसी क्षेत्र में भेजता है; CLI इसी से होस्ट निकालता है, इसलिए आपको URL सेट नहीं करना पड़ता।

कोड उदाहरण
bird auth create-org "Acme" --workspace-name "Production" --region us1 --onboarding-ticket "YOUR_ONBOARDING_TICKET"

पुष्टि करें कि क्रेडेंशियल काम करता है:

कोड उदाहरण
bird auth status   # authenticated: true, valid: true

खाता सक्रिय है और प्रमाणित हो चुका है। अब एजेंट चैनल कॉन्फ़िगर करने और संदेश भेजने के लिए CLI का उपयोग कर सकता है।

चलाने से पहले CLI इनपुट जाँचें

हर चरण अपना विवरण स्वयं देता है और उसे किसी क्रेडेंशियल की आवश्यकता नहीं होती, इसलिए एजेंट कुछ भी भेजने से पहले पूरी शृंखला की योजना बना सकता है। bird auth --help चरणों का क्रमबद्ध प्रवाह दिखाता है, --example संपादन के लिए तैयार अनुरोध बॉडी दिखाता है, और --response-schema वे फ़ील्ड दिखाता है जो हर कमांड लौटाता है।

curl का उपयोग करें

आपको curl और jq की आवश्यकता है, लेकिन Bird CLI, MCP कनेक्शन, API कुंजी या ब्राउज़र सत्र की नहीं। सभी कमांड एक ही शेल में चलाएँ और कोई अनुरोध विफल हो तो रुक जाएँ। शुरू करने से पहले us1 या eu1 चुनें, क्योंकि संगठन बनाने का अनुरोध उसी होस्ट पर जाना चाहिए जो उसके region से मेल खाता हो।

कोड उदाहरण
umask 077
BIRD_SIGNUP_DIR=$(mktemp -d)
BIRD_REGION=us1
BIRD_BASE_URL="https://${BIRD_REGION}.platform.bird.com"
BIRD_EMAIL=you@example.com

निजी डायरेक्टरी में सत्यापन प्रतिक्रिया और क्रेडेंशियल रहते हैं। इन फ़ाइलों को सोर्स कंट्रोल, चैट ट्रांसक्रिप्ट और साझा लॉग से दूर रखें।

1. साइन-इन कोड का अनुरोध करें

कोड उदाहरण
jq -n --arg email "$BIRD_EMAIL" '{email: $email}' |
  curl --fail-with-body --silent --show-error \
    "$BIRD_BASE_URL/v1/auth/magic-link" \
    -H 'Content-Type: application/json' --data-binary @-

सफल अनुरोध बिना बॉडी के 204 लौटाता है। ईमेल से छह अंकों का कोड पढ़ें; यह 15 मिनट बाद समाप्त हो जाता है। प्रतिक्रिया से यह पता नहीं चलता कि खाता पहले से मौजूद है या नहीं।

2. ईमेल का सत्यापन करें

123456 की जगह ईमेल से मिला कोड डालें। प्रतिक्रिया को उसका ऑनबोर्डिंग टिकट प्रिंट किए बिना सहेजें:

कोड उदाहरण
BIRD_CODE=123456
jq -n --arg email "$BIRD_EMAIL" --arg code "$BIRD_CODE" \
  '{email: $email, code: $code}' |
  curl --fail-with-body --silent --show-error \
    "$BIRD_BASE_URL/v1/auth/magic-link/verify-code" \
    -H 'Content-Type: application/json' --data-binary @- \
    --output "$BIRD_SIGNUP_DIR/verified.json"
jq -e '.onboarding_ticket | type == "string" and length > 0' \
  "$BIRD_SIGNUP_DIR/verified.json" > /dev/null

आगे तभी बढ़ें जब सत्यापन सफल हो और टिकट की जाँच सफलतापूर्वक पूरी हो। नए सत्यापित खाते को एक बार उपयोग होने वाला onboarding_ticket मिलता है। जिस मौजूदा खाते में पहले से संगठन है, उसे इस साइनअप प्रवाह की आवश्यकता नहीं है; यदि सत्यापन के लिए MFA आवश्यक हो, तो इसके बजाय मौजूदा खाते का साइन-इन प्रवाह पूरा करें।

3. संगठन और वर्कस्पेस बनाएँ

अपने संगठन और वर्कस्पेस के नाम चुनें, और region को BIRD_BASE_URL के अनुरूप रखें। यह अनुरोध टिकट का उपयोग करता है, इसलिए कुकी जार या बेयरर टोकन की ज़रूरत नहीं है:

कोड उदाहरण
jq -n --arg region "$BIRD_REGION" \
  --slurpfile verified "$BIRD_SIGNUP_DIR/verified.json" \
  '{org_name: "Acme", workspace_name: "Production", region: $region,
    onboarding_ticket: $verified[0].onboarding_ticket}' |
  curl --fail-with-body --silent --show-error \
    "$BIRD_BASE_URL/v1/auth/onboarding" \
    -H 'Content-Type: application/json' --data-binary @- \
    --output "$BIRD_SIGNUP_DIR/account.json"

सफल प्रतिक्रिया 201 होती है और उसमें organization, workspace, access_token, token_type और expires_in होते हैं, और जारी होने पर एक रिफ़्रेश टोकन भी। एक्सेस टोकन expires_in में दिए गए सेकंड बीतने पर समाप्त हो जाता है। प्रतिक्रिया को सुरक्षित रूप से सहेजें। यह खाते का एक बार का सेटअप है; जिस खाते में पहले से संगठन है, उसे 409 मिलता है।

4. प्रमाणित अनुरोध भेजें

बेयरर हेडर को एक निजी curl कॉन्फ़िगरेशन फ़ाइल में लिखें, फिर क्रेडेंशियल से जुड़ी पहचान पढ़ें:

कोड उदाहरण
jq -er '.access_token | select(type == "string" and length > 0) |
  "header = \"Authorization: Bearer \(.)\""' \
  "$BIRD_SIGNUP_DIR/account.json" > "$BIRD_SIGNUP_DIR/curl-auth.conf"
curl --fail-with-body --silent --show-error \
  --config "$BIRD_SIGNUP_DIR/curl-auth.conf" "$BIRD_BASE_URL/v1/auth/me"

200 पहचान प्रतिक्रिया से पुष्टि होती है कि क्रेडेंशियल काम करता है। आगे की API कॉल के लिए वही बेयरर हेडर और क्षेत्रीय होस्ट इस्तेमाल करें। curl क्रेडेंशियल को CLI या किसी MCP क्लाइंट में इंस्टॉल नहीं करता; अस्थायी डायरेक्टरी हटाने से पहले सहेजे गए क्रेडेंशियल अपने एप्लिकेशन के सीक्रेट स्टोर में ले जाएँ।

अगले कदम

संबंधित संसाधन

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।

इम्प्लीमेंटेशन ब्रीफ़ पाएँ