Skip to main content
POST
/
api
/
v1
/
runtime
/
v1
/
connectors
/
{connector}
Execute Connector
curl --request POST \
  --url https://api.runflow.ai/api/v1/runtime/v1/connectors/{connector} \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource": "get-users",
  "action": "get",
  "data": {
    "path": {
      "id": "123"
    },
    "query": {
      "limit": 10
    },
    "body": {
      "name": "John"
    },
    "headers": {
      "X-Custom": "value"
    }
  },
  "options": {
    "useMock": false,
    "timeout": 5000
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.runflow.ai/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
connector
string
required

Connector slug or name

Query Parameters

​
environment
string

staging | production. Falls back to instance default.

Body

application/json
​
resource
string
required

Resource slug

Example:

"get-users"

​
action
string

Action to perform (deprecated, optional)

Example:

"get"

​
data
object

Request data - can be flat or structured format

Example:
{
  "path": { "id": "123" },
  "query": { "limit": 10 },
  "body": { "name": "John" },
  "headers": { "X-Custom": "value" }
}
​
options
object

Execution options (mock, timeout, credentials, etc)

Example:
{ "useMock": false, "timeout": 5000 }

Response

Connector response envelope: { success, data, metadata: { connector, resource, ... } } when successful. On error returns { success: false, error, fallback?: true }.