Sign inGet Started

Samodzielna rejestracja

Większość agentów działa na koncie, które już posiadasz: konfigurujesz agenta, a on loguje się przez przeglądarkę. Ten przewodnik opisuje drugą ścieżkę, w której agent bez konta tworzy je samodzielnie, w całości z terminala. Użyj CLI lub curl, aby zweryfikować adres e-mail i utworzyć organizację, obszar roboczy oraz poświadczenie. Lokalny serwer stdio MCP wymaga zapisanego poświadczenia, zanim będzie mógł wystartować; hostowany MCP nie udostępnia narzędzi rejestracji. Potrzebujesz dostępu do skrzynki e-mail, aby odczytać kod weryfikacyjny. Rejestracje przez Bird CLI lub serwer MCP są przypisywane do narzędzia, które je wykonało.

Użyj CLI

Do poniższych poleceń CLI potrzebujesz zainstalowanego bird CLI. Rejestracja i weryfikacja są niezależne od regionu i nie wymagają początkowej konfiguracji. W ostatnim kroku przekaż --region (us1 lub eu1) do create-org, aby wybrać, gdzie będą przechowywane konto i jego dane. Nazwy hostów ani zmienne środowiskowe nie są wymagane.

1. Poproś o kod logowania

bird auth signup wysyła e-mailem sześciocyfrowy kod logowania. Weryfikacja tego kodu tworzy konto, jeśli adres e-mail jest nowy. Używa tej samej ścieżki bezhasłowego magic-link co dashboard, więc wysłany kod to wszystko, czego potrzebujesz. Zachowaj adres e-mail na następny krok.

Przykład kodu
bird auth signup you@example.com
# { "email": "you@example.com", "status": "code_sent" }

2. Zweryfikuj e-mail

Sześciocyfrowy kod przychodzi e-mailem, więc pochodzi spoza CLI: odczytaj go ze skrzynki odbiorczej. Przekaż go wraz z tym samym adresem e-mail do bird auth verify-email, które loguje cię i w przypadku zupełnie nowego konta zwraca jednorazowy onboarding_ticket.

Przykład kodu
bird auth verify-email you@example.com --code 123456
# { "onboarding_ticket": "...", "user_id": "usr_..." }

3. Utwórz organizację

bird auth create-org wykorzystuje bilet, aby utworzyć organizację i obszar roboczy, a następnie zapisuje wygenerowane poświadczenie, dzięki czemu CLI i lokalny serwer stdio MCP od tego momentu uwierzytelniają się jako nowe konto. To operacja jednorazowa: drugie wywołanie zwraca 409. --region wybiera, gdzie będą przechowywane konto i jego dane (us1 lub eu1) i kieruje wywołanie do tego regionu; CLI wyprowadza z niego hosta, więc nie musisz ustawiać URL-a.

Przykład kodu
bird auth create-org "Acme" --workspace-name "Production" --region us1 --onboarding-ticket "YOUR_ONBOARDING_TICKET"

Potwierdź, że poświadczenie działa:

Przykład kodu
bird auth status   # authenticated: true, valid: true

Konto jest aktywne i uwierzytelnione. Agent może teraz używać CLI, aby konfigurować kanały i wysyłać wiadomości.

Sprawdź dane wejściowe CLI przed uruchomieniem

Każdy krok jest samoopisujący i nie wymaga poświadczenia, więc agent może zaplanować cały łańcuch, zanim cokolwiek wyśle. bird auth --help wypisuje uporządkowany przepływ, --example wypisuje gotowe do edycji ciało żądania, a --response-schema wypisuje pola zwracane przez każde polecenie.

Użyj curl

Potrzebujesz curl i jq, ale nie potrzebujesz Bird CLI, połączenia MCP, klucza API ani sesji przeglądarki. Uruchamiaj polecenia w tej samej powłoce, przerywając w razie błędu żądania. Wybierz us1 lub eu1 przed rozpoczęciem; żądanie tworzenia organizacji musi trafić na hosta odpowiadającego jego region.

Przykład kodu
umask 077
BIRD_SIGNUP_DIR=$(mktemp -d)
BIRD_REGION=us1
BIRD_BASE_URL="https://${BIRD_REGION}.platform.bird.com"
BIRD_EMAIL=you@example.com

Prywatny katalog przechowuje odpowiedź weryfikacji i poświadczenia. Nie umieszczaj tych plików w kontroli wersji, transkrypcjach czatu ani współdzielonych logach.

1. Poproś o kod logowania

Przykład kodu
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 @-

Pomyślne żądanie zwraca 204 bez ciała. Odczytaj sześciocyfrowy kod z e-maila; wygasa po 15 minutach. Odpowiedź nie ujawnia, czy konto już istnieje.

2. Zweryfikuj e-mail

Zastąp 123456 kodem otrzymanym e-mailem. Zapisz odpowiedź bez wypisywania biletu onboardingowego:

Przykład kodu
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

Kontynuuj tylko wtedy, gdy weryfikacja się powiodła i sprawdzenie biletu zakończyło się pomyślnie. Nowe zweryfikowane konto otrzymuje jednorazowy onboarding_ticket. Istniejące konto z organizacją nie potrzebuje tego przepływu rejestracji; jeśli weryfikacja wymaga MFA, dokończ przepływ logowania istniejącego konta.

3. Utwórz organizację i obszar roboczy

Wybierz nazwy organizacji i obszaru roboczego, zachowując zgodność region z BIRD_BASE_URL. To żądanie używa biletu, więc nie jest potrzebny plik cookie ani token bearer:

Przykład kodu
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"

Pomyślna odpowiedź to 201 i zawiera organization, workspace, access_token, token_type oraz expires_in, a także refresh token, jeśli został wydany. Token dostępu wygasa po liczbie sekund podanej w expires_in. Przechowuj odpowiedź bezpiecznie. To jednorazowa konfiguracja konta; konto, które już ma organizację, otrzymuje 409.

4. Wykonaj uwierzytelnione żądanie

Zapisz nagłówek bearer do prywatnego pliku konfiguracyjnego curl, a następnie odczytaj tożsamość stojącą za poświadczeniem:

Przykład kodu
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"

Odpowiedź tożsamości 200 potwierdza, że poświadczenie działa. Używaj tego samego nagłówka bearer i regionalnego hosta w kolejnych wywołaniach API. Curl nie instaluje poświadczeń w CLI ani w kliencie MCP; przenieś zapisane poświadczenia do magazynu sekretów swojej aplikacji przed usunięciem tymczasowego katalogu.

Następne kroki