upseamdocs Upseam home GitHub
Contents

// Get started

Upseam documentation

Upseam is Dependabot for APIs. It is a GitHub App that knows which API versions, SDKs and AI models your repositories use. When a provider ships a change that touches your code, Upseam finds the exact lines. Once you connect a model, it asks your team in Slack or in a GitHub issue, then writes a fix with that model and opens a pull request. You review it.

Upseam is in a free beta, installed by link.

What Upseam does

  • Install, pick repositories, done. No YAML and no secrets on the default path. See Install the GitHub App.
  • Fix pull requests for mechanical changes. Removed, renamed and retyped fields and methods get a pull request. Behavior changes are listed for you under "Needs you" instead of being guessed at.
  • Works with Dependabot. When a Dependabot or Renovate pull request bumps a tracked SDK and the bump breaks your code, Upseam asks for approval and then opens a pull request with the bump and the code fix.
  • Retired AI models. When a vendor retires a model your code names and names one successor, you can approve a pull request to it, with a note to review parameters and behavior.
  • Your own APIs. When your backend changes its OpenAPI or GraphQL contract, the frontends that consume it get a pull request.
  • Approve in Slack or the dashboard issue, or open pull requests automatically. New repositories start in the ask mode. See Delivery modes.
  • Bring your own model. Anthropic or OpenAI with your key, or any OpenAI-compatible endpoint with the stored-key method. See Connect a model.
  • Upseam never stores your code. See Security model.

What Upseam does not do

  • It does not run your tests before the pull request. Your own CI runs on the pull request, and Upseam reports the result.
  • It does not fix every breaking change. Only mechanical changes are patched; everything else is flagged with the file and line.
  • It does not bump SDKs. That stays Dependabot's or Renovate's job; Upseam fixes the code a bump breaks.
  • It does not cover every API. See Providers and Languages for what is supported today.

Start here

  1. Read How it works for the flow from a vendor change to a pull request.
  2. Install the GitHub App and pick repositories.
  3. Connect a model to get fix pull requests, and optionally connect Slack.
  4. Add .github/upseam.yml only if you want internal contracts or ignore rules.