Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Body

application/json
name
string
required

Display name of the source.

Required string length: 1 - 200
Example:

"Engineering docs"

source_type
string
default:direct_file_uploads

Only direct_file_uploads is accepted.

scope
enum<string>
default:personal

Which Brain the source belongs to. team requires team_id.

Available options:
personal,
team,
organization
team_id
string

The team for scope: team. Not accepted with other scopes.

require_approval
boolean
default:false

Create as a draft that estimates credits before anything is indexed.

Response

Source created.

source
object
required