Knorish

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 Users | list-users | Retrieve a paginated list of users with optional search and date filters | | List Courses | list-courses | Retrieve a paginated list of courses | | List Bundles | list-bundles | Retrieve a paginated list of bundles | | Get User | get-user | Retrieve details of a specific user by ID | | Get Course | get-course | Retrieve details of a specific course by ID | | Get Bundle | get-bundle | Retrieve details of a specific bundle by ID | | Create User | create-user | Create a new user in Knorish | | Update User | update-user | Update an existing user's details | | Delete User | delete-user | Remove a user from Knorish | | Delete Course | delete-course | Remove a course from Knorish | | Delete Bundle | delete-bundle | Remove a bundle from Knorish | | Get User Courses | get-user-courses | Retrieve courses a user is enrolled in | | Get User Bundles | get-user-bundles | Retrieve bundles a user is enrolled in | | Get Course Users | get-course-users | Retrieve users enrolled in a course | | Get Bundle Users | get-bundle-users | Retrieve users enrolled in a bundle | | Get Bundle Courses | get-bundle-courses | Retrieve courses in a bundle | | Add User to Course | add-user-to-course | Enroll a user in a course | | Add User to Bundle | add-user-to-bundle | Enroll a user in a bundle | | Remove User from Course | remove-user-from-course | Unenroll a user from a course | | Remove User from Bundle | remove-user-from-bundle | Unenroll a user from a bundle |

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 Knorish 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