Search documentation
Search pages, API reference sections, and guide headings.
Summary
Connectors provide the storage access boundary for imports and exports. This guide shows how to create them, test them, and choose scopes safely.
Choose connector scopes first
A connector can support:
importexport- both
If the connector should only receive exports, do not give it import scope.
Create a GCS connector
GCS connector creation uses multipart form data because the public surface accepts a service account JSON file.
curl -X POST https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/connectors/gcs \
-H "Authorization: Bearer <token-or-api-key>" \
-F "name=Broadcast storage" \
-F "bucket=archive-bucket" \
-F "gcp_project_id=media-project-123" \
-F "scopes=import" \
-F "credentials_file=@service-account.json"
Create S3 or Azure connectors
S3 and Azure connector creation uses JSON payloads with provider-specific credentials and optional export_base_path.
Test and browse the connector
After creation:
- Call the test endpoint to validate credentials and access.
- Browse the connector with a prefix and pattern before you start an import job.
connector = client.connectors.create_s3(
name="Archive S3",
bucket="media-archive",
region="us-east-1",
aws_access_key_id="AKIA...",
aws_secret_access_key="...",
scopes=["import", "export"],
export_base_path="exports/team-a",
)
client.connectors.test(connector.connector_id)
files = client.connectors.browse(connector.connector_id, prefix="incoming/", pattern="*.mp4")
Import mode
Connectors expose import_mode such as:
allnew_only
Use new_only when the connector should behave as a dedupe-oriented ingestion source across repeated workflows.
Related documentation
Connectors are the public storage integration boundary for import and export workflows. The API supports provider-specific creation, listing, retrieval, testing, browsing, update, and deletion.
This guide covers one-time import jobs and persistent index-level import automations that watch a storage location and trigger processing with a prompt preset.
Use exports to package result data for download or connector delivery, then use export automations when the handoff should persist per index.
