Skip to content

Organizations

Create Search source

Create a source in the prepared organization Search index using the same provider validation as Settings. Use connector-types list for provider configuration. This does not override an explicit integration approval decision. Organization admin required. OAuth scope: `api:write`.

POST/api/v2/organizations/{organizationId}/search/sources

Create a source in the prepared organization Search index using the same provider validation as Settings. Use connector-types list for provider configuration. This does not override an explicit integration approval decision. Organization admin required.

OAuth scope: api:write.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:write

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:write.

Path parameters

organizationIdstringRequired

Organization identifier.

minLength
1

Request body

Required

Source configuration.

object

Source configuration.

6 fields
connectorTypestringRequired

Registered connector type.

minLength
1
maxLength
100
credentialIdstring

OAuth credential identifier for connector types whose auth.mode is oauth (see connector types), or a saved credential for an apiKey connector type that declares auth.savedCredential (such as Amazon S3 with a saved AWS credential); otherwise omit it for apiKey connectors.

minLength
1
maxLength
255
apiKeystring

Write-only API key for connector types whose auth.mode is apiKey (see connector types), or a personal access token for an OAuth connector that also accepts one, such as GitHub. Send it instead of credentialId. Pass a raw key, or a secret reference written as the whole value {{SECRET_NAME}}, which the server resolves; $SECRET_NAME is not a reference.

minLength
1
maxLength
10000
sourceConfigobjectRequired

Connector-specific source selection and filtering configuration.

Schema details
Additional propertiesvalue

Connector-specific source configuration value.

accessModestring

Source-managed permissions (admin), or individually connected member accounts (members).

default
admin
enum
["admin","members"]
permissionConfigvalue

Provider-specific permissions for initial setup. Large CSV snapshots use permission imports after creation.

Schema details

Exactly one of

Option 1object
5 fields
providerstringRequired

Provider of the configured Search source.

const
gitlab
modestringRequired

Administrator lookup or externally managed CSV permissions.

enum
["administrator","csv"]
expectedRevisioninteger

Current permission revision obtained before generating this snapshot.

minimum
0
maximum
9007199254740991
userMappingobject

GitLab user IDs and their verified Sim email addresses.

2 fields
filenamestringRequired

CSV filename without path separators.

minLength
1
maxLength
255
contentstringRequired

UTF-8 CSV contents, up to 8 MiB. Both files travel in one request body limited to 10 MiB after JSON encoding.

minLength
1

Additional properties are not allowed.

projectPermissionsobject

GitLab project paths and the IDs of users granted access.

2 fields
filenamestringRequired

CSV filename without path separators.

minLength
1
maxLength
255
contentstringRequired

UTF-8 CSV contents, up to 8 MiB. Both files travel in one request body limited to 10 MiB after JSON encoding.

minLength
1

Additional properties are not allowed.

Additional properties are not allowed.

Additional properties are not allowed.

Responses

201

Source operation result.

object

Source operation result.

1 field
dataobjectRequired

Response data.

10 fields
idstringRequired

Unique connector identifier.

minLength
1
connectorTypestringRequired

Registered external source type.

minLength
1
credentialIdvalueRequired

OAuth credential identifier, or the saved credential an apiKey source syncs with (see auth.savedCredential); null for unauthenticated sources and for apiKey sources that use an inline API key.

Schema details

Any of

Option 1string
Option 2null
sourceConfigobjectRequired

Connector-specific source selection and filtering configuration.

Schema details
Additional propertiesvalue

Connector-specific source configuration value.

statusstringRequired

Current connector state. pending means a sync is queued but not yet running.

enum
["active","paused","pending","syncing","error","disabled"]
createdAtstringRequired

Time the connector was created.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAtstringRequired

Time the connector was last updated.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
accessModestringRequired

Source-managed permissions (admin), or individually connected member accounts (members).

enum
["admin","members"]
approvedbooleanRequired

Whether the organization has approved this integration. Approval is independent of source status.

permissionConfigvalueRequired

Permission revision and file summaries, without CSV contents.

Schema details

Any of

Option 1value
Schema details

Exactly one of

Option 1object
5 fields
providerstringRequired

Permission provider.

const
gitlab
modestringRequired

Administrator lookup or externally managed CSV permissions.

enum
["administrator","csv"]
revisionintegerRequired

Current revision of the stored permissions.

minimum
0
maximum
9007199254740991
userMappingvalueRequired

User mapping file summary, or null when not supplied.

Schema details

Any of

Option 1object
3 fields
filenamestringRequired

Uploaded CSV filename.

minLength
1
maxLength
255
uploadedAtstringRequired

Upload time in UTC.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
rowCountintegerRequired

Number of uploaded data records.

minimum
0
maximum
5000000

Additional properties are not allowed.

Option 2null
projectPermissionsvalueRequired

Project permission file summary, or null when not supplied.

Schema details

Any of

Option 1object
3 fields
filenamestringRequired

Uploaded CSV filename.

minLength
1
maxLength
255
uploadedAtstringRequired

Upload time in UTC.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
rowCountintegerRequired

Number of uploaded data records.

minimum
0
maximum
5000000

Additional properties are not allowed.

Option 2null

Additional properties are not allowed.

Option 2null

Additional properties are not allowed.

Additional properties are not allowed.

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit