Skip to content

docs(inboxes): Authorize Inbox returns api_key_id and instructions - #253

Merged
sidharth0612 merged 1 commit into
mainfrom
claude/thin-authorize-response
Sep 17, 2026
Merged

sidharth0612 merged 1 commit into
mainfrom
claude/thin-authorize-response

Conversation

@sidharth0612

Copy link
Copy Markdown
Contributor

Summary

Pairs with agentmail-to/agentmail-api#1332, which thins the POST /v0/inboxes/{inbox_id}/authorize response to { api_key_id, instructions }.

  • Fern definition: the endpoint now returns AuthorizeInboxResponse instead of api-keys.PublicKeyCredential. instructions is typed as the literal "Authorization complete. Return to browser." so SDK regenerations keep the sentence fixed.
  • AgentID Sign-In guide: the authorize examples print api_key_id and instructions, and the prose points readers to Get API Key under Check activation for status.
  • Changelog: a 2026-09-16 entry with the migration (read status from GET /v0/api-keys/{api_key_id}).

Test plan

  • fern check passes, 0 errors, warning count unchanged from main

🤖 Generated with Claude Code

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>
@github-actions

Copy link
Copy Markdown

📋 View the side-by-side API change review

The 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 review: false on the action.

@github-actions

Copy link
Copy Markdown

✨ 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 api-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@github-actions

Copy link
Copy Markdown

@sidharth0612
sidharth0612 merged commit 441f731 into main Sep 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants