Skip to content

Collections

A collection is a directory of .yml files, one per request.

my-collection/
├── .environments/
│ ├── production.env
│ └── staging.env
├── .noodle/
│ └── ui-state.yml # UI state (auto-generated)
├── .timeline/ # Response history (auto-generated)
├── settings.yml
├── users/
│ ├── folder.yml
│ ├── list.yml
│ ├── create.yml
│ └── delete.yml
├── example.yml
└── another-request.yml

The .noodle/ and .timeline/ directories are created automatically. .noodle/ stores UI state (last selected request, expanded folders, tab preferences). .timeline/ stores response history — one file per request, pruned to the 50 most recent entries. Both are safe to commit or ignore.

name: Get Users
method: GET
url: https://api.example.com/users
headers:
- key: Accept
value: application/json
enabled: true
Field Type Required Description
name string yes Display name in sidebar
method string yes HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)
url string yes Request URL (supports {{var}} substitution)
headers array no Array of header objects
params array no Array of query parameter objects
auth object no Override collection/folder auth
body_type string no none, json, urlencoded, multipart, or binary
body string no Raw body content
timeout number no Request timeout in ms

Optional metadata for organizing collections:

name: Users API
seq: 0
overrides:
headers:
Accept:
key: Accept
value: application/json
enabled: true
auth:
type: bearer
token: "{{folder_token}}"
Field Description
name Display name in sidebar. Falls back to directory name
seq Custom sort position. Folders without seq sort alphabetically
overrides Headers and auth inherited by child requests

Requests inherit headers and auth from their parent folder. Set auth: { type: inherit } on a request to use the nearest parent’s auth config. Set auth: { type: none } to disable auth for a specific request.

When a folder is focused in the sidebar, the Folder Pane shows an Activity tab with per-request stats:

Column Description
Method HTTP method
Name Request name
OK% Success rate — green ≥90%, yellow ≥50%, red below
Avg Average response time
Last Calls + time since last send

Stats are computed from the request timeline.

Collection-wide settings:

environment: production
keybindings:
request_send: ctrl+enter