Mixedbread

Authorize Gmail

Start Gmail OAuth; the response redirects to Google's consent page.

GET
/v1/integrations/gmail/oauth/authorize

Every call creates an installation, also for an account the organization already connected, e.g. the same mailbox feeding a second store; the same account in another organization is that organization's own. To refresh an existing installation's credentials, reconnect it through GET /v1/integrations/gmail/installations/{installation_id}/oauth/authorize instead.

After consent the browser returns to the organization's return URL with status, installation_id or error, and reference. error is store_in_use when another installation of the account already feeds the store, store_exists when new_store names a store that exists by then, store_change_on_refresh or reconnect_account_mismatch for the deprecated installation_id, and otherwise the provider's error (such as access_denied), scope_not_granted when consent left out a scope the connector needs, invalid_state, token_exchange_failed or callback_failed.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Api key to access Mixedbreads API

Query Parameters

store_name?|

Ingestion store name. A store that already exists is shared: every data source connected to it ingests into it, except another installation of the same account, which would ingest every item again. Without it, the account's default store, numbered past a store another installation of the account feeds. Rejected with 422 when the connect refreshes an existing installation and names a store other than its own.

new_store?New Store

Ingest into a store created for this connection: the connect fails with 409 when store_name names a store that already exists, and without store_name the default name is numbered past existing stores. Rejected with 422 when the connect refreshes an existing installation, which keeps its store.

Defaultfalse
installation_id?|Deprecated

Gmail installation ID when reconnecting an existing installation. Deprecated: use GET /v1/integrations/gmail/installations/{installation_id}/oauth/authorize.

reference?|

Opaque value echoed back as reference on the return URL, so your app can match the outcome to the user who started the flow

metadata_contextualization?Metadata Contextualization

Contextualize chunks with the connector's curated metadata fields

Defaulttrue
file_contextualization?File Contextualization

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

Defaulttrue
ingestion_mode?StoreFileParsingStrategy

Parsing strategy for imported files

Default"high_quality"
Value in"fast""high_quality"

Response Body

Redirect to Google OAuth

response?unknownapplication/json
Example Request
curl -s -o /dev/null -w '%{redirect_url}' \  'https://api.mixedbread.com/v1/integrations/gmail/oauth/authorize?store_name=mail-olivia&reference=user-42' \  -H 'Authorization: Bearer YOUR_API_KEY'
Example Response
null