Skip to main content
POST
memory.connector.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
namespace
string
required

Which set of documents to work on: an id you choose per user, project or tenant (letters, digits, "_", ":", "-", at most 83 characters). Use the same value across the memory capabilities.

Required string length: 1 - 83
Pattern: ^[a-zA-Z0-9_:-]+$
ref
string
required

The ref returned by memory.connectors.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeSyncs
boolean
default:false

True also returns the last 10 import runs with their failed items. Default false.

Response

The result

namespace
string
required

The namespace the imported documents go into.

source
enum<string>
required

The system the connector imports from.

Available options:
notion,
google-drive,
onedrive,
gmail,
github,
web-crawler,
s3,
granola
status
enum<string>
required

pending_authorization until the person finished signing in to the source; then active.

Available options:
pending_authorization,
active
documentLimit
number

The most documents this connector imports.

documentCount
number

How many documents it has imported so far.

selectable
boolean

True when what to import can be chosen from a list of the source's items.

lastSuccessfulSyncAt
string

When an import last finished successfully, ISO 8601.

createdAt
string

When the connector was created, ISO 8601.

latestRun
object

The most recent import run.

runs
object[]

The last 10 import runs, newest first. Only with includeSyncs.