MImixedbread
integrations

Authorize SharePoint integration

Changed on

Start the Microsoft sign-in that connects a work or school account as a new SharePoint installation.

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

After consent the browser returns to the dashboard, or to the return URL of the organization's own Microsoft Entra app when it registered one, with provider, status, installation_id and reference. A failed connect carries status=error and error: 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, the provider's own error (such as access_denied, or consent_required when the account's organization only lets an administrator approve apps), sharepoint_not_available when the account's Microsoft 365 organization has no SharePoint, invalid_state, token_exchange_failed or callback_failed.

get/v1/integrations/sharepoint/oauth/authorize

Request

  • Base URL
    https://api.mixedbread.com
  • Auth
    HTTP bearer

Query parameters

store_namestring nullable

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_storeboolean

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.

referencestring nullable

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_contextualizationboolean

Contextualize chunks with the connector's curated metadata fields

file_contextualizationboolean

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

ingestion_mode'fast' | 'high_quality'

Strategy for adding a file to a store.

Parsing strategy for imported files

Changes