Faros

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has state: "READY", skip to Step 2.

#### 1b. Wait for the connection to be ready

If the connection is in BUILDING state, poll until it's ready:

npx @membranehq/cli connection get  --wait --json

The --wait flag long-polls (up to --timeout seconds, default 30) until the state changes. Keep polling until state is no longer BUILDING.

The resulting state tells you what to do next:

After the user completes the action (e.g. authenticates in the browser), poll again with membrane connection get --json to check if the state moved to READY.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes id, name, description, inputSchema (what parameters the action accepts), and outputSchema (what it returns).

Popular actions

| Name | Key | Description | |---|---|---| | List Graphs | list-graphs | Lists all graphs in the Faros tenant | | List Accounts | list-accounts | List all accounts (data source configurations) in Faros. | | List Webhooks | list-webhooks | Lists webhooks with optional graph and source filters | | List Named Queries | list-named-queries | Gets a list of all named queries | | List API Keys | list-api-keys | Lists all tenant API keys | | List Account Syncs | list-account-syncs | Get list of sync statuses for a tenant account | | List Secrets | list-secrets | List all secrets, optionally filtered by group. | | Get Graph | get-graph | Gets a graph by name | | Get Account | get-account | Gets a tenant account by account ID | | Get Webhook | get-webhook | Gets a webhook definition by its ID | | Get Named Query | get-named-query | Get a named (saved) query by its name. | | Get Secret | get-secret | Get a specific secret by name, optionally specifying a group. | | Create Account | create-account | Sets up a new account for a tenant | | Create Webhook | create-webhook | Creates a new webhook definition for receiving events from external sources (GitHub, GitLab, Jira) | | Create Named Query | create-named-query | Creates a new named query | | Create API Key | create-api-key | Creates a new tenant API key | | Create Secret | create-secret | Creates a secret value for a given name | | Update Account | update-account | Update an account (data source configuration) in Faros. | | Update Webhook | update-webhook | Updates an existing webhook definition | | Delete Account | delete-account | Deletes a tenant account |

Running actions

membrane action run  --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run  --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the output field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Faros API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices