Index GCS File | Captain Docs

Index a single file from a GCS bucket into a collection.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID

Index a single file from a GCS bucket into a collection. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID

Path parameters

collection_namestringRequired

Name of the collection to index into

Request

This endpoint expects an object.

bucket_namestringRequired

file_uristringRequired

GCS URI format: gs://bucket-name/path/to/file.pdf

service_account_jsonstringRequired

Response

Indexing Job Started

job_idstring

statusenum

Allowed values:

1	import requests
2
3	url = "https://api.runcaptain.com/v2/collections/collection_name/index/gcs/file"
4
5	payload = {
6	"bucket_name": "my-company-docs",
7	"file_uri": "gs://my-company-docs/contracts/acme_contract.pdf",
8	"service_account_json": "{\"type\":\"service_account\",\"project_id\":\"my-project\",...}"
9	}
10	headers = {
11	"Authorization": "Bearer YOUR_API_KEY",
12	"X-Organization-ID": "YOUR_ORG_UUID",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"job_id": "string",
3	"status": "pending"
4	}