Skip to main content
POST
Run a bounded generated-code probe against an external data connection.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Path Parameters

connection_id
string<uuid>
required

Body

application/json
mode
enum<string>
default:python

Use python for arbitrary source probes. Use query when generated Python should execute the provided read-only SQL/SOQL query via ctx.query.

Available options:
python,
query
code
string | null

Generated Python code for the executor. Define run(ctx) or run(). The result should be a pandas DataFrame, list of records, or dict of named DataFrames/records/scalars. RUNTIME_* globals contain raw Secret Manager strings; generated code should parse them according to secret metadata, for example json.loads(RUNTIME_ATTIO_API_TOKEN)['token'] for token secrets.

query
string | null
Minimum string length: 1
query_language
enum<string>
default:sql
Available options:
sql,
soql
configuration
Configuration · object

Optional non-secret runtime configuration for standalone generated-code execution. Connection-bound execution uses the saved connection configuration.

discovery_metadata
Discovery Metadata · object

Optional non-secret metadata available to standalone generated code as ctx.discovery_metadata.

parameters
Parameters · object
secret_names
string[]

Optional secret names to resolve through the backend and expose to generated code as RUNTIME_<SECRET_NAME> globals. The globals contain raw Secret Manager payload strings that code must parse according to each secret_type.

Maximum array length: 20
limit
integer
default:25

Maximum sample rows returned to the agent per output table.

Required range: 1 <= x <= 500
timeout_seconds
integer
default:60
Required range: 1 <= x <= 120

Response

Successful Response

execution_id
string
required
status
enum<string>
required
Available options:
succeeded,
failed
connection
ConnectionRead · object | null
outputs
Outputs · object
metadata
Metadata · object
stdout_tail
string
default:""
stderr_tail
string
default:""
error
Error · object | null