docs(inboxes): Authorize Inbox returns api_key_id and instructions - #253
Merged
Merged
Conversation
The authorize response is now thin (agentmail-api #1332): the pending key's api_key_id plus a fixed instructions line, "Authorization complete. Return to browser." The Fern definition types the response as AuthorizeInboxResponse with instructions as a literal so regenerations keep the sentence. The guide reads the key's status from Get API Key instead of the authorize response, and a changelog entry carries the migration. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
📋 View the side-by-side API change reviewThe link expires in 7 days. 🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. How it works → Posted automatically by the oasdiff GitHub Action. To turn this off (no spec upload, no comment), set |
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/inboxes/{inbox_id}/authorize
- :warning: removed the required property `created_at` from the response with the `202` status
- :warning: removed the required property `created_by` from the response with the `202` status
- :warning: removed the required property `name` from the response with the `202` status
- :warning: removed the required property `permissions` from the response with the `202` status
- :warning: removed the required property `type` from the response with the `202` status
- :warning: removed the required property `updated_at` from the response with the `202` status
- removed the optional property `client_id` from the response with the `202` status
- removed the optional property `expires_at` from the response with the `202` status
- removed the optional property `inbox_id` from the response with the `202` status
- removed the optional property `pod_id` from the response with the `202` status
- removed the optional property `public_key` from the response with the `202` status
- removed the optional property `status` from the response with the `202` status
- removed the optional property `used_at` from the response with the `202` status
- added the required property `instructions` to the response with the `202` status💡 Download |
duharry0915
approved these changes
Sep 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pairs with agentmail-to/agentmail-api#1332, which thins the
POST /v0/inboxes/{inbox_id}/authorizeresponse to{ api_key_id, instructions }.AuthorizeInboxResponseinstead ofapi-keys.PublicKeyCredential.instructionsis typed as the literal"Authorization complete. Return to browser."so SDK regenerations keep the sentence fixed.api_key_idandinstructions, and the prose points readers to Get API Key under Check activation forstatus.statusfromGET /v0/api-keys/{api_key_id}).Test plan
fern checkpasses, 0 errors, warning count unchanged from main🤖 Generated with Claude Code