Skip to content
Structly Docs
한국어

Getting started

Record your first Catalog entry

On this page

Follow these steps with a verified Organization selected. For setup, see Set up your account and Organization.

Record in the Web UI#

  1. Check the current Organization under ORGANIZATION in the left sidebar.
  2. Select APIs under CATALOG.
  3. Select 새 API (New API) and enter an 이름 (name). handle is filled in with a candidate made from the name, and you can change it to the value to use in the address. 요약 (summary) and 설명 (description) are optional.
  4. Select API 등록 (Register API). The new API appears in the list.

The list shows the name and summary. Select an entry to view and edit its details in the panel on the right. For the difference between a summary and a description, see Concepts.

Record with stly#

Log in to stly first. Then create an input file named api.json.

{"name": "Orders API", "handle": "orders-api", "summary": "Create and look up orders", "description": "Public API provided by the orders Service."}

handle is the name used in the Web address and must be unique among the APIs of the same Organization.

Check the request with --dry-run, then run the command. --dry-run does not send a request to the server.

stly apis create --input api.json --dry-run
stly apis create --input api.json

On success, status is 201 and data contains the saved API.

{"status":201,"etag":null,"location":"/api/apis/4pkKFh2ojXs","data":{"id":"4pkKFh2ojXs","handle":"orders-api","name":"Orders API","summary":"Create and look up orders","description":"Public API provided by the orders Service.","base_urls":[],"created_at":"2026-10-24T15:25:12.158122Z","updated_at":"2026-10-24T15:25:12.158122Z"}}

Check the record#

stly apis list --q Orders --fields id,name
stly apis get 4pkKFh2ojXs

apis list --q searches the name, summary, and description, and is case-sensitive. --fields keeps only the fields you list in the output. APIs recorded in the Web UI appear in the same commands, and APIs recorded with stly appear in the Web UI list.

Next steps#