Sign in
assistants

Changed on

Start an OAuth authorization flow for a given provider.

The requesting user must own the assistant or belong to the same organization.

post/v1/assistants/{assistant_id}/oauth/{provider}/start/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Path parameters

assistant_idstring uuid required
providerstring required

Request body

requested_scopesstring[]
redirect_after_connectstring
tenant_hoststring

Response

successboolean required
deferredboolean required
provider'twitter' | 'google' | 'outlook' | 'linear' | 'github' | 'asana' | 'notion' | 'todoist' | 'dropbox' | 'discord' | 'airtable' | 'hubspot' | 'salesforce' | 'eventbrite' | 'calendly' | 'monday' | 'figma' | 'stripe_link' | 'shopify' | 'quickbooks' required
  • twitter - twitter
  • google - google
  • outlook - outlook
  • linear - linear
  • github - github
  • asana - asana
  • notion - notion
  • todoist - todoist
  • dropbox - dropbox
  • discord - discord
  • airtable - airtable
  • hubspot - hubspot
  • salesforce - salesforce
  • eventbrite - eventbrite
  • calendly - calendly
  • monday - monday
  • figma - figma
  • stripe_link - stripe_link
  • shopify - shopify
  • quickbooks - quickbooks
connect_urlstring uri required
state_idstring uuid required

Changes

  • a7001eedf3faRevision changes
    • ●

      added the new free_tier_daily_limit_reached enum value to the response property for the response status

  • 6a3b586b3195Revision changes
    • ●

      added the new assistant_not_live enum value to the response property for the response status