Create your first function

Create an account

UI

Open registration and enter your email, password, and an optional name. After registration, you land in your personal organization’s function list. If you already have an account, sign in.

curl

Replace the name and email below, run the request, and enter your password when prompted. This example uses Python 3 to prepare the JSON body:

python3 - <<'PY' | curl https://api.str.ing/auth/register \
  -H 'Content-Type: application/json' \
  --data-binary @-
import getpass
import json

print(json.dumps({
    "name": "Alex Example",
    "email": "you@example.com",
    "password": getpass.getpass("Password: "),
}))
PY

Set STRING_TOKEN to the session_token returned in the response. If you already have an account, use the login endpoint.

str api

Create an account if needed. With the str CLI installed, sign in and choose your organization during authorization:

str login

str api uses the credential saved by str login. In request paths, {org} expands to that credential’s organization slug.

Choose an organization

Organizations define your team’s permissions, members, spending controls, and API keys. Use the organization whose access and spending should apply to your work.

UI

The breadcrumb at the top of the page shows the current organization. Open the organization picker in the sidebar to select another organization you belong to. On a phone, open the navigation menu first.

curl

Check your account’s memberships:

curl https://api.str.ing/auth/verify \
  -H "Authorization: Bearer $STRING_TOKEN"

Choose a slug from the response’s organizations array. Replace acme below with that slug.

str api

Check which organization your credential acts for:

str api /auth/whoami

To choose another organization, run str login again and select it during authorization.

Create a function

Creating a function requires a role with write access. Viewers can read the list.

UI

On the Functions page, enter a name such as Classify support tickets and submit the creation form. The new function appears in the list. Open it to edit and save its draft source.

curl

curl https://api.str.ing/acme/functions \
  -H "Authorization: Bearer $STRING_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Classify support tickets"}'

Use the returned slug or ID to save a draft.

str api

str api '/{org}/functions' -d '{"name":"Classify support tickets"}'

Use the returned slug or ID to save a draft.

Return later

UI

Sign in again to return to your personal organization, or your first available organization. Choose Sign out in the navigation when you finish using a shared device.

curl

Use your session token until it expires. Send POST /auth/logout to end the session; see authentication.

str api

Your saved CLI credential is reused across commands. Run str logout to remove it when you finish using a shared machine.