Runs

Run a connector

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

Request

  • Base URL: https://api.indices.io
  • URL: https://api.indices.io/v1beta/runs
  • Auth: HTTP bearer

Request body

connector_idstring required

ID of the connector to execute.

argumentsobject

Arguments to pass to the connector. Optional if the connector does not require any arguments.

secret_bindingsobject

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.

secret_valuesobject

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.

asyncboolean

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.

max_timeout_sinteger

Maximum execution time in seconds before the run is timed out.

Response

Successful response

idstring required

Unique identifier for the object.

connector_idstring required

ID of the connector executed in this run.

connector_versioninteger required

Version of the connector executed in this run. Runs pin the version that was newest when they were created.

argumentsobject required

Arguments in this run for the connector's input parameters.

secret_bindingsobject

Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.

status'pending' | 'running' | 'success' | 'connector_error' | 'timed_out' | 'result_too_large' | 'internal_error' required
resultobject nullable required

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.

result_storedboolean required

Whether the result is retained for later retrieval.

result_size_bytesinteger nullable required

Size of the executor's serialized result in UTF-8 bytes, when known.

has_logsboolean required

Whether the run has associated logs

created_atstring date-time required

Timestamp when the object was created.

finished_atstring date-time nullable required

Timestamp when the object was last updated.

Example response

{
  "connector_version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.