Authorize Gmail

GET/v1/integrations/gmail/oauth/authorize

Authorization

Authorizationstringrequired

Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Query Parameters

store_namestring

Optional ingestion store name

installation_idstring(uuid)

Gmail installation ID when reconnecting an existing installation

metadata_contextualizationbooleandefault: true

Contextualize chunks with the connector's curated metadata fields

file_contextualizationbooleandefault: true

Generate an LLM context for each chunk situating it within the full document

ingestion_modeenumdefault: high_quality

Parsing strategy for imported files

Possible values

fasthigh_quality

Response

307 with Location set to the provider's consent page. After consent the browser is redirected to the return URL registered on the organization's app, with these query parameters appended:

providerstringrequired

The connector: gmail

statusenumrequired

installation_idstring

The installation that was created or reconnected. Present when `status` is `connected`.

errorenum

Why consent failed. Present when `status` is `error`. Provider errors such as `access_denied` are passed through.

Possible values

access_deniedmissing_codeaccount_already_connectedreconnect_account_mismatchinvalid_statetoken_exchange_failedcallback_failed

Request

cURL

GET/v1/integrations/gmail/oauth/authorize

curl -s -o /dev/null -w '%{redirect_url}' \
  'https://api.mixedbread.com/v1/integrations/gmail/oauth/authorize?store_name=mail-olivia' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Redirects

cURL

# Location header of the 307: send the browser here
https://accounts.google.com/o/oauth2/v2/auth?client_id=…&redirect_uri=…&scope=…&access_type=offline&state=…

# Return URL after consent
https://platform.example.com/connected?provider=gmail&status=connected&installation_id=2f1c9a8e-6b4d-4e3a-9c1f-7d8e5b6a4c21

# Return URL when consent fails
https://platform.example.com/connected?provider=gmail&status=error&error=account_already_connected