Skip to main content

Authentication

Scribe securely stores all private data in the cloud. In order to upload, access and delete data via the API, all requests must be authenticated.

In order to authenticate, you will first need a Scribe account and a client ID.

API requests need to be authenticated using AWS sigv4. We recommend using one of our auth libraries for this.

Scribe SDKs​

Scribe Private Information SDKs are the recommended method of accessing the Private Information API. The SDKs handle authentication (via the Scribe auth libraries).

SDK Example (Python)​

from ScribeMi import MI

client = MI({
    'API_URL': 'mi.scribelabs.ai/v1',
    'REGION': 'eu-west-2',
    'IDENTITY_POOL_ID': 'Contact Scribe for authentication details',
    'USER_POOL_ID': 'Contact Scribe for authentication details',
    'CLIENT_ID': 'Contact Scribe for authentication details',
})

# Authenticate with username / password
client.authenticate({ 'username': 'myUsername', 'password': 'myPassword' })

# OR with refresh token
client.authenticate({ 'refresh_token': 'myRefreshToken' })

SDK Example (TypeScript)​

import { ScribeMIClient } from '@scribelabsai/mi';

const client = new ScribeMIClient({
  API_URL: 'mi.scribelabs.ai/v1',
  REGION: 'eu-west-2',
  IDENTITY_POOL_ID: 'Contact Scribe for authentication details',
  USER_POOL_ID: 'Contact Scribe for authentication details',
  CLIENT_ID: 'Contact Scribe for authentication details',
});

// Authenticate with username / password
await client.authenticate({ username: 'myUsername', password: 'myPassword' });

// OR with refresh token
await client.authenticate({ refreshToken: 'myRefreshToken' });

Scribe auth libraries​

Without using the Scribe SDKs, you can use Scribe auth libraries directly: