import Indices from 'indicesio';
const client = new Indices({
apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
});
const run = await client.beta.runs.create({ connector_id: 'connector_id' });
console.log(run.id);
import os
from indices import Indices
client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
run = client.beta.runs.create(
connector_id="connector_id",
)
print(run.id)
Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it’s ready.
POST
/
v1beta
/
runs
JavaScript
import Indices from 'indicesio';
const client = new Indices({
apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
});
const run = await client.beta.runs.create({ connector_id: 'connector_id' });
console.log(run.id);
import os
from indices import Indices
client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
run = client.beta.runs.create(
connector_id="connector_id",
)
print(run.id)
Mapping of secret slot names to the IDs of saved, user-owned secrets. Each of the connector's required_secrets must appear here or in secret_values, but not both.
Mapping of secret slot names to secret values supplied directly for this run, instead of referencing a saved secret. Use a login shape ({username, password, totp_secret?}) for login slots and a string shape ({value}) for string slots. Values are not persisted.
When true, return immediately with a pending run; poll retrieveRun for the result. Results above 1,000,000 UTF-8 JSON bytes are discarded and finish with result_too_large. Retry those requests with async=false to receive the result directly.
Lifecycle status of the run: pending, running, success, connector_error, timed_out, result_too_large, or internal_error. connector_error means the connector's code failed (see error); timed_out and internal_error are platform outcomes worth retrying; result_too_large means the result exceeded the execution limit or could not be retained for an async caller. Async results above 1 MB require a new synchronous request.
Execution result of the run, matching the connector's output schema. Synchronous requests return successful results up to the 100 MB execution limit. Only results of at most 1,000,000 UTF-8 JSON bytes are stored. Larger results are returned once to the synchronous caller and are null on later retrieval. If delivery fails, the result cannot be retrieved later.
Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Indices Documentation","colors":{"primary":"#252525","light":"#d9694f","dark":"#9c351e"},"logo":{"light":"https://mintcdn.com/ayu-ba4d74dc/o7hgbj8ZCWvi48gy/logo/light.svg?fit=max\u0026auto=format\u0026n=o7hgbj8ZCWvi48gy\u0026q=85\u0026s=88f85a703467b200c8c694d272e4a675","dark":"https://mintcdn.com/ayu-ba4d74dc/o7hgbj8ZCWvi48gy/logo/dark.svg?fit=max\u0026auto=format\u0026n=o7hgbj8ZCWvi48gy\u0026q=85\u0026s=3bea042a168f29dc30c8c8a7986c0190"},"favicon":"https://mintcdn.com/ayu-ba4d74dc/o7hgbj8ZCWvi48gy/favicon.svg?fit=max\u0026auto=format\u0026n=o7hgbj8ZCWvi48gy\u0026q=85\u0026s=14b5b939040d6c652063090b5512499b","appearance":{"default":"light"},"background":{"color":{"light":"#fdfcf5","dark":"#1a1612"}},"fonts":{"heading":{"family":"Geist","weight":600},"body":{"family":"Geist"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Contact the founders","icon":"envelope","href":"mailto:founders@indices.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ayu-ba4d74dc","hasAudioNarration":false,"actualSubdomain":"ayu-ba4d74dc","customDomains":["beta-docs-prod.indices.io"],"gitSource":{"type":"github","owner":"itsaphel","repo":"indices-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae38e486300d92dbf3ce7ed","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":29},{"language":"default","tag":"Endpoints","count":26},{"language":"default","tag":"Files","count":7},{"language":"default","tag":"Capture Sessions","count":6},{"language":"default","tag":"Documentation","count":5},{"language":"default","tag":"Connectors","count":5},{"language":"default","tag":"Runs","count":4},{"language":"default","tag":"Secrets","count":4},{"language":"default","tag":"API Reference","count":3},{"language":"default","tag":"Getting started","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/runs/run-a-connector","slug":"/api-reference/runs/run-a-connector","pageMetadata":{"title":"Run a connector","description":"\u003cp>Execute a connector. By default the call blocks until the run finishes. Pass \u003ccode>async: true\u003c/code> to return immediately, in which case you should poll \u003ccode>GET /runs\u003c/code> to retrieve the result once it's ready.\u003c/p>","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/runs","href":"/api-reference/runs/run-a-connector","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n return _jsxs(\"p\", {\n children: [\"Execute a connector. By default the call blocks until the run finishes. Pass \", _jsx(\"code\", {\n children: \"async: true\"\n }), \" to return immediately, in which case you should poll \", _jsx(\"code\", {\n children: \"GET /runs\"\n }), \" to retrieve the result once it’s ready.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a connector","description":"\u003cp>Execute a connector. By default the call blocks until the run finishes. Pass \u003ccode>async: true\u003c/code> to return immediately, in which case you should poll \u003ccode>GET /runs\u003c/code> to retrieve the result once it's ready.\u003c/p>","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/runs","href":"/api-reference/runs/run-a-connector","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Runs"],"summary":"Run a connector","description":"\u003cp>Execute a connector. By default the call blocks until the run finishes. Pass \u003ccode>async: true\u003c/code> to return immediately, in which case you should poll \u003ccode>GET /runs\u003c/code> to retrieve the result once it's ready.\u003c/p>","operationId":"createRun","requestBody":"ff2ad3ac-be1f-4668-b8d2-be6cddf51e12","responses":{"200":"f1340c36-bfdb-443d-b2c3-d65e10c9a68e","202":"3b32219d-87c8-4a0e-888b-2f5f49c5555a","422":"90b2fbcb-ee0e-4965-8e1a-d1a703656f65"},"x-codeSamples":[{"lang":"JavaScript","source":"import Indices from 'indicesio';\n\nconst client = new Indices({\n apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.runs.create({ connector_id: 'connector_id' });\n\nconsole.log(run.id);"},{"lang":"Python","source":"import os\nfrom indices import Indices\n\nclient = Indices(\n api_key=os.environ.get(\"INDICES_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.beta.runs.create(\n connector_id=\"connector_id\",\n)\nprint(run.id)"}],"method":"post","type":"path","servers":["5381d28e-0ade-4304-9b36-8d40596c8a23"],"security":["be82033e-0722-4878-9296-d2c04a44ce8d"],"path":"/v1beta/runs","baseUrlOptions":["https://api.indices.io"],"title":"Run a connector","codeSamples":[{"lang":"JavaScript","source":"import Indices from 'indicesio';\n\nconst client = new Indices({\n apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.runs.create({ connector_id: 'connector_id' });\n\nconsole.log(run.id);"},{"lang":"Python","source":"import os\nfrom indices import Indices\n\nclient = Indices(\n api_key=os.environ.get(\"INDICES_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.beta.runs.create(\n connector_id=\"connector_id\",\n)\nprint(run.id)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"connector_id":{"type":"string","description":"ID of the connector to execute.","isRequired":true,"uniqueKey":"connector_id","typeLabel":"string"},"arguments":{"additionalProperties":true,"type":"object","description":"Arguments to pass to the connector. Optional if the connector does not require any arguments.","uniqueKey":"arguments","typeLabel":"object"},"secret_bindings":{"additionalProperties":{"type":"string","uniqueKey":"secret_bindings.additionalProperties","typeLabel":"string"},"type":"object","description":"Mapping of secret slot names to the IDs of saved, user-owned secrets. Each of the connector's required_secrets must appear here or in secret_values, but not both.","uniqueKey":"secret_bindings","typeLabel":"object"},"secret_values":{"additionalProperties":{"oneOf":[{"type":"object","title":"LoginSecretValue","required":["username","password"],"properties":{"username":{"type":"string","description":"Username for the login.","isRequired":true,"uniqueKey":"secret_values.additionalProperties.oneOf.0.username","typeLabel":"string"},"password":{"type":"string","description":"Password for the login.","isRequired":true,"uniqueKey":"secret_values.additionalProperties.oneOf.0.password","typeLabel":"string"},"totp_secret":{"oneOf":[{"type":"string","description":"TOTP seed, when the login uses 2FA.","uniqueKey":"secret_values.additionalProperties.oneOf.0.totp_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"TOTP seed, when the login uses 2FA.","uniqueKey":"secret_values.additionalProperties.oneOf.0.totp_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"secret_values.additionalProperties.oneOf.0.totp_secret","typeLabel":"string | null"}},"uniqueKey":"secret_values.additionalProperties.oneOf.0","typeLabel":"LoginSecretValue · object"},{"type":"object","title":"StringSecretValue","required":["value"],"properties":{"value":{"type":"string","description":"The secret value.","isRequired":true,"uniqueKey":"secret_values.additionalProperties.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"secret_values.additionalProperties.oneOf.1","typeLabel":"StringSecretValue · object"}],"uniqueKey":"secret_values.additionalProperties","typeLabel":"LoginSecretValue · object | StringSecretValue · object"},"type":"object","description":"Mapping of secret slot names to secret values supplied directly for this run, instead of referencing a saved secret. Use a login shape ({username, password, totp_secret?}) for login slots and a string shape ({value}) for string slots. Values are not persisted.","uniqueKey":"secret_values","typeLabel":"object"},"async":{"type":"boolean","description":"When true, return immediately with a pending run; poll retrieveRun for the result. Results above 1,000,000 UTF-8 JSON bytes are discarded and finish with result_too_large. Retry those requests with async=false to receive the result directly.","default":false,"uniqueKey":"async","typeLabel":"boolean"},"max_timeout_s":{"type":"integer","maximum":3600,"minimum":1,"description":"Maximum execution time in seconds before the run is timed out.","default":300,"uniqueKey":"max_timeout_s","typeLabel":"integer"},"proxy_settings":{"oneOf":[{"type":"object","title":"IspProxy","description":"Proxy for the network traffic of this run. If you do not set it, a setting is automatically determined by the platform.","required":["location"],"properties":{"location":{"type":"string","const":"us","title":"Location","isRequired":true,"uniqueKey":"proxy_settings.oneOf.0.location","typeLabel":"string"},"type":{"type":"string","const":"isp","title":"Type","default":"isp","uniqueKey":"proxy_settings.oneOf.0.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"proxy_settings.oneOf.0","typeLabel":"IspProxy · object"},{"type":"object","title":"ResidentialProxy","description":"Proxy for the network traffic of this run. If you do not set it, a setting is automatically determined by the platform.","required":["location"],"properties":{"location":{"type":"string","enum":["at","be","ca","ch","de","dk","es","fi","fr","gb","ie","it","lu","mx","nl","no","pt","se","us"],"isRequired":true,"uniqueKey":"proxy_settings.oneOf.1.location","typeLabel":"enum\u003cstring>"},"type":{"type":"string","const":"residential","title":"Type","default":"residential","uniqueKey":"proxy_settings.oneOf.1.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"proxy_settings.oneOf.1","typeLabel":"ResidentialProxy · object"},{"type":"null","description":"Proxy for the network traffic of this run. If you do not set it, a setting is automatically determined by the platform.","uniqueKey":"proxy_settings.oneOf.2","typeLabel":"null"}],"uniqueKey":"proxy_settings","typeLabel":"IspProxy · object | ResidentialProxy · object | null"}},"type":"object","required":["connector_id"],"title":"CreateRunRequest","uniqueKey":"","typeLabel":"CreateRunRequest · object"},"examples":{"Example":{"title":"Example","value":{"connector_id":"\u003cstring>","arguments":{},"secret_bindings":{},"secret_values":{},"async":false,"max_timeout_s":300,"proxy_settings":{"location":"us","type":"isp"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f1340c36-bfdb-443d-b2c3-d65e10c9a68e":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"connector_id":{"type":"string","description":"ID of the connector executed in this run.","isRequired":true,"uniqueKey":"connector_id","typeLabel":"string"},"connector_version":{"type":"integer","description":"Version of the connector executed in this run. Runs pin the version that was newest when they were created.","examples":[1],"example":1,"isRequired":true,"uniqueKey":"connector_version","typeLabel":"integer"},"arguments":{"additionalProperties":true,"type":"object","description":"Arguments in this run for the connector's input parameters.","isRequired":true,"uniqueKey":"arguments","typeLabel":"object"},"status":{"type":"string","enum":["pending","running","success","connector_error","timed_out","result_too_large","internal_error"],"title":"RunStatus","description":"Lifecycle status of the run: `pending`, `running`, `success`, `connector_error`, `timed_out`, `result_too_large`, or `internal_error`. `connector_error` means the connector's code failed (see `error`); `timed_out` and `internal_error` are platform outcomes worth retrying; `result_too_large` means the result exceeded the execution limit or could not be retained for an async caller. Async results above 1 MB require a new synchronous request.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"result":{"oneOf":[{"type":"object","description":"Execution result of the run, matching the connector's output schema. Synchronous requests return successful results up to the 100 MB execution limit. Only results of at most 1,000,000 UTF-8 JSON bytes are stored. Larger results are returned once to the synchronous caller and are null on later retrieval. If delivery fails, the result cannot be retrieved later.","additionalProperties":true,"isRequired":true,"uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Execution result of the run, matching the connector's output schema. Synchronous requests return successful results up to the 100 MB execution limit. Only results of at most 1,000,000 UTF-8 JSON bytes are stored. Larger results are returned once to the synchronous caller and are null on later retrieval. If delivery fails, the result cannot be retrieved later.","isRequired":true,"uniqueKey":"result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result","typeLabel":"object | null"},"result_stored":{"type":"boolean","description":"Whether the result is retained for later retrieval.","isRequired":true,"uniqueKey":"result_stored","typeLabel":"boolean"},"result_size_bytes":{"oneOf":[{"type":"integer","description":"Size of the executor's serialized result in UTF-8 bytes, when known.","isRequired":true,"uniqueKey":"result_size_bytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Size of the executor's serialized result in UTF-8 bytes, when known.","isRequired":true,"uniqueKey":"result_size_bytes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result_size_bytes","typeLabel":"integer | null"},"error":{"oneOf":[{"type":"object","title":"RunError","description":"Why the run failed. Present iff `status` is `connector_error`; for platform failures the status itself is the reason.","required":["type","message","retryable","exception","details"],"properties":{"type":{"type":"string","description":"Machine-readable failure type: `auth_required`, `invalid_input`, `site_unavailable`, `anti_bot`, `site_changed`, `internal_error`, `crash`, or `unhandled`.","isRequired":true,"uniqueKey":"error.oneOf.0.type","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the failure.","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"retryable":{"oneOf":[{"type":"boolean","description":"Whether retrying the run with the same arguments is expected to succeed. Null when unknown.","isRequired":true,"uniqueKey":"error.oneOf.0.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether retrying the run with the same arguments is expected to succeed. Null when unknown.","isRequired":true,"uniqueKey":"error.oneOf.0.retryable.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.retryable","typeLabel":"boolean | null"},"exception":{"oneOf":[{"type":"string","description":"Exception class name, when the failure came from a raised exception.","isRequired":true,"uniqueKey":"error.oneOf.0.exception.oneOf.0","typeLabel":"string"},{"type":"null","description":"Exception class name, when the failure came from a raised exception.","isRequired":true,"uniqueKey":"error.oneOf.0.exception.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.exception","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","description":"Structured context reported by the connector.","additionalProperties":true,"isRequired":true,"uniqueKey":"error.oneOf.0.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Structured context reported by the connector.","isRequired":true,"uniqueKey":"error.oneOf.0.details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.details","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"RunError · object"},{"type":"null","description":"Why the run failed. Present iff `status` is `connector_error`; for platform failures the status itself is the reason.","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"RunError · object | null"},"has_logs":{"type":"boolean","description":"Whether the run has associated logs","isRequired":true,"uniqueKey":"has_logs","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the object was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"finished_at":{"oneOf":[{"type":"string","description":"Timestamp when the object was last updated.","format":"date-time","isRequired":true,"uniqueKey":"finished_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp when the object was last updated.","isRequired":true,"uniqueKey":"finished_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"finished_at","typeLabel":"string\u003cdate-time> | null"},"secret_bindings":{"additionalProperties":{"type":"string","uniqueKey":"secret_bindings.additionalProperties","typeLabel":"string"},"type":"object","description":"Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.","uniqueKey":"secret_bindings","typeLabel":"object"}},"type":"object","required":["id","connector_id","connector_version","arguments","status","result","result_stored","result_size_bytes","error","has_logs","created_at","finished_at"],"title":"Run","uniqueKey":"","typeLabel":"Run · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","connector_id":"\u003cstring>","connector_version":1,"arguments":{},"status":"pending","result":{},"result_stored":true,"result_size_bytes":123,"error":{"type":"\u003cstring>","message":"\u003cstring>","retryable":true,"exception":"\u003cstring>","details":{}},"has_logs":true,"created_at":"2023-11-07T05:31:56Z","finished_at":"2023-11-07T05:31:56Z","secret_bindings":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"3b32219d-87c8-4a0e-888b-2f5f49c5555a":{"description":"Async run accepted; poll `get /runs` until it reaches a terminal status.","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"connector_id":{"type":"string","description":"ID of the connector executed in this run.","isRequired":true,"uniqueKey":"connector_id","typeLabel":"string"},"connector_version":{"type":"integer","description":"Version of the connector executed in this run. Runs pin the version that was newest when they were created.","examples":[1],"example":1,"isRequired":true,"uniqueKey":"connector_version","typeLabel":"integer"},"arguments":{"additionalProperties":true,"type":"object","description":"Arguments in this run for the connector's input parameters.","isRequired":true,"uniqueKey":"arguments","typeLabel":"object"},"status":{"type":"string","enum":["pending","running","success","connector_error","timed_out","result_too_large","internal_error"],"title":"RunStatus","description":"Lifecycle status of the run: `pending`, `running`, `success`, `connector_error`, `timed_out`, `result_too_large`, or `internal_error`. `connector_error` means the connector's code failed (see `error`); `timed_out` and `internal_error` are platform outcomes worth retrying; `result_too_large` means the result exceeded the execution limit or could not be retained for an async caller. Async results above 1 MB require a new synchronous request.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"result":{"oneOf":[{"type":"object","description":"Execution result of the run, matching the connector's output schema. Synchronous requests return successful results up to the 100 MB execution limit. Only results of at most 1,000,000 UTF-8 JSON bytes are stored. Larger results are returned once to the synchronous caller and are null on later retrieval. If delivery fails, the result cannot be retrieved later.","additionalProperties":true,"isRequired":true,"uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Execution result of the run, matching the connector's output schema. Synchronous requests return successful results up to the 100 MB execution limit. Only results of at most 1,000,000 UTF-8 JSON bytes are stored. Larger results are returned once to the synchronous caller and are null on later retrieval. If delivery fails, the result cannot be retrieved later.","isRequired":true,"uniqueKey":"result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result","typeLabel":"object | null"},"result_stored":{"type":"boolean","description":"Whether the result is retained for later retrieval.","isRequired":true,"uniqueKey":"result_stored","typeLabel":"boolean"},"result_size_bytes":{"oneOf":[{"type":"integer","description":"Size of the executor's serialized result in UTF-8 bytes, when known.","isRequired":true,"uniqueKey":"result_size_bytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Size of the executor's serialized result in UTF-8 bytes, when known.","isRequired":true,"uniqueKey":"result_size_bytes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result_size_bytes","typeLabel":"integer | null"},"error":{"oneOf":[{"type":"object","title":"RunError","description":"Why the run failed. Present iff `status` is `connector_error`; for platform failures the status itself is the reason.","required":["type","message","retryable","exception","details"],"properties":{"type":{"type":"string","description":"Machine-readable failure type: `auth_required`, `invalid_input`, `site_unavailable`, `anti_bot`, `site_changed`, `internal_error`, `crash`, or `unhandled`.","isRequired":true,"uniqueKey":"error.oneOf.0.type","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the failure.","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"retryable":{"oneOf":[{"type":"boolean","description":"Whether retrying the run with the same arguments is expected to succeed. Null when unknown.","isRequired":true,"uniqueKey":"error.oneOf.0.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether retrying the run with the same arguments is expected to succeed. Null when unknown.","isRequired":true,"uniqueKey":"error.oneOf.0.retryable.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.retryable","typeLabel":"boolean | null"},"exception":{"oneOf":[{"type":"string","description":"Exception class name, when the failure came from a raised exception.","isRequired":true,"uniqueKey":"error.oneOf.0.exception.oneOf.0","typeLabel":"string"},{"type":"null","description":"Exception class name, when the failure came from a raised exception.","isRequired":true,"uniqueKey":"error.oneOf.0.exception.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.exception","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","description":"Structured context reported by the connector.","additionalProperties":true,"isRequired":true,"uniqueKey":"error.oneOf.0.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Structured context reported by the connector.","isRequired":true,"uniqueKey":"error.oneOf.0.details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.oneOf.0.details","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"RunError · object"},{"type":"null","description":"Why the run failed. Present iff `status` is `connector_error`; for platform failures the status itself is the reason.","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"RunError · object | null"},"has_logs":{"type":"boolean","description":"Whether the run has associated logs","isRequired":true,"uniqueKey":"has_logs","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the object was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"finished_at":{"oneOf":[{"type":"string","description":"Timestamp when the object was last updated.","format":"date-time","isRequired":true,"uniqueKey":"finished_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp when the object was last updated.","isRequired":true,"uniqueKey":"finished_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"finished_at","typeLabel":"string\u003cdate-time> | null"},"secret_bindings":{"additionalProperties":{"type":"string","uniqueKey":"secret_bindings.additionalProperties","typeLabel":"string"},"type":"object","description":"Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.","uniqueKey":"secret_bindings","typeLabel":"object"}},"type":"object","required":["id","connector_id","connector_version","arguments","status","result","result_stored","result_size_bytes","error","has_logs","created_at","finished_at"],"title":"Run","uniqueKey":"","typeLabel":"Run · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","connector_id":"\u003cstring>","connector_version":1,"arguments":{},"status":"pending","result":{},"result_stored":true,"result_size_bytes":123,"error":{"type":"\u003cstring>","message":"\u003cstring>","retryable":true,"exception":"\u003cstring>","details":{}},"has_logs":true,"created_at":"2023-11-07T05:31:56Z","finished_at":"2023-11-07T05:31:56Z","secret_bindings":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"90b2fbcb-ee0e-4965-8e1a-d1a703656f65":{"description":"Validation error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"be82033e-0722-4878-9296-d2c04a44ce8d":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Enter your API key as the bearer token. Set header: `Authorization` to `Bearer \u003capi_key>`","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5381d28e-0ade-4304-9b36-8d40596c8a23":{"url":"https://api.indices.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Enter your API key as the bearer token. Set header: `Authorization` to `Bearer \u003capi_key>`","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your API key as the bearer token. Set header: `Authorization` to `Bearer \u003capi_key>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"ayu-ba4d74dc","siteName":"Indices Documentation","title":"Run a connector - Indices Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T18:21:29.603Z","originalFileLocation":"api-reference/runs/run-a-connector.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it\u0026#x27;s ready.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Indices Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a connector - Indices Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it\u0026#x27;s ready.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Indices Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ayu-ba4d74dc.mintlify.site/_mintlify/api/og/v2?division=Runs\u0026amp;title=Run+a+connector\u0026amp;description=%3Cp%3EExecute+a+connector.+By+default+the+call+blocks+until+the+run+finishes.+Pass+%3Ccode%3Easync%3A+true%3C%2Fcode%3E+to+return+immediately%2C+in+which+case+you+should+poll+%3Cc\u0026amp;theme=f34c5d234ad6e6a3c8840bf3\u0026amp;signature=6bf8a6abab421dea321f7c95956f55032cbb45190295130ab5d9982288252352\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run a connector - Indices Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it\u0026#x27;s ready.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ayu-ba4d74dc.mintlify.site/_mintlify/api/og/v2?division=Runs\u0026amp;title=Run+a+connector\u0026amp;description=%3Cp%3EExecute+a+connector.+By+default+the+call+blocks+until+the+run+finishes.+Pass+%3Ccode%3Easync%3A+true%3C%2Fcode%3E+to+return+immediately%2C+in+which+case+you+should+poll+%3Cc\u0026amp;theme=f34c5d234ad6e6a3c8840bf3\u0026amp;signature=6bf8a6abab421dea321f7c95956f55032cbb45190295130ab5d9982288252352\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ayu-ba4d74dc/9jPMOFRFRsLJbq7n/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Indices Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#252525\">\u003clink data-mint-head rel=\"canonical\" href=\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/runs/run-a-connector.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://beta-docs-prod.indices.io/#organization\",\"name\":\"Indices Documentation\",\"url\":\"https://beta-docs-prod.indices.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ayu-ba4d74dc/o7hgbj8ZCWvi48gy/logo/light.svg?fit=max\u0026auto=format\u0026n=o7hgbj8ZCWvi48gy\u0026q=85\u0026s=88f85a703467b200c8c694d272e4a675\"}},{\"@type\":\"WebSite\",\"@id\":\"https://beta-docs-prod.indices.io#website\",\"name\":\"Indices Documentation\",\"url\":\"https://beta-docs-prod.indices.io\",\"publisher\":{\"@id\":\"https://beta-docs-prod.indices.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector#webpage\",\"url\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector\",\"name\":\"Run a connector\",\"description\":\"Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it's ready.\",\"dateModified\":\"2026-10-29T18:21:29.603Z\",\"isPartOf\":{\"@id\":\"https://beta-docs-prod.indices.io#website\"},\"breadcrumb\":{\"@id\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://beta-docs-prod.indices.io/api-reference/capture-sessions/list-capture-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Runs\",\"item\":\"https://beta-docs-prod.indices.io/api-reference/runs/list-runs\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Run a connector\",\"item\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector#apireference\",\"headline\":\"Run a connector\",\"name\":\"Run a connector\",\"description\":\"Execute a connector. By default the call blocks until the run finishes. Pass async: true to return immediately, in which case you should poll GET /runs to retrieve the result once it's ready.\",\"url\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector\",\"mainEntityOfPage\":{\"@id\":\"https://beta-docs-prod.indices.io/api-reference/runs/run-a-connector#webpage\"},\"dateModified\":\"2026-10-29T18:21:29.603Z\",\"publisher\":{\"@id\":\"https://beta-docs-prod.indices.io/#organization\"},\"isPartOf\":{\"@id\":\"https://beta-docs-prod.indices.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Indices Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Indices Documentation","nav":{"global":{"anchors":[{"anchor":"Contact the founders","icon":"envelope","href":"mailto:founders@indices.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Rate limits","href":"/api-reference/rate_limits"}]},{"group":"Endpoints","pages":[{"group":"Capture Sessions","pages":[{"title":"List capture sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/capture_sessions","href":"/api-reference/capture-sessions/list-capture-sessions"},{"title":"Start a capture session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/capture_sessions","href":"/api-reference/capture-sessions/start-a-capture-session"},{"title":"Retrieve a capture session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/capture_sessions/{id}","href":"/api-reference/capture-sessions/retrieve-a-capture-session"},{"title":"Complete a capture session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/capture_sessions/{id}/complete","href":"/api-reference/capture-sessions/complete-a-capture-session"},{"title":"Paste a secret value into a capture session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/capture_sessions/{id}/paste","href":"/api-reference/capture-sessions/paste-a-secret-value-into-a-capture-session"},{"title":"Abandon a capture session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/capture_sessions/{id}/abandon","href":"/api-reference/capture-sessions/abandon-a-capture-session"}]},{"group":"Runs","pages":[{"title":"List runs","description":"\u003cp>List runs of a given connector.\u003c/p>","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/runs","href":"/api-reference/runs/list-runs"},{"title":"Run a connector","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/runs","href":"/api-reference/runs/run-a-connector"},{"title":"Retrieve a run","description":"\u003cp>Retrieve a run by its ID.\u003c/p>","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/runs/{run_id}","href":"/api-reference/runs/retrieve-a-run"},{"title":"Get run logs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/runs/{run_id}/logs","href":"/api-reference/runs/get-run-logs"}]},{"group":"Connectors","pages":[{"title":"List connectors","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Retrieve a connector","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/connectors/{connector_id}","href":"/api-reference/connectors/retrieve-a-connector"},{"title":"Delete a connector","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1beta/connectors/{connector_id}","href":"/api-reference/connectors/delete-a-connector"},{"title":"Rename a connector","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1beta/connectors/{connector_id}","href":"/api-reference/connectors/rename-a-connector"},{"title":"List a connector's revisions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/connectors/{connector_id}/revisions","href":"/api-reference/connectors/list-a-connectors-revisions"}]},{"group":"Files","pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/files","href":"/api-reference/files/list-files"},{"title":"Initiate a file upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/files","href":"/api-reference/files/initiate-a-file-upload"},{"title":"Finalize a file upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/files/{file_id}/complete","href":"/api-reference/files/finalize-a-file-upload"},{"title":"Retrieve a file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/files/{file_id}","href":"/api-reference/files/retrieve-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1beta/files/{file_id}","href":"/api-reference/files/delete-a-file"},{"title":"Get a file download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/files/{file_id}/download_url","href":"/api-reference/files/get-a-file-download-url"},{"title":"Download a file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/files/{file_id}/download","href":"/api-reference/files/download-a-file"}]},{"group":"Secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1beta/secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Create secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/secrets","href":"/api-reference/secrets/create-secret"},{"title":"Generate TOTP code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1beta/secrets/{id}/totp","href":"/api-reference/secrets/generate-totp-code"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1beta/secrets/{id}","href":"/api-reference/secrets/delete-secret"}]}]}]}]},"basePath":"","title":"Run a connector - Indices Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}