Collections
Collections store reusable requests for HTTP, GraphQL, gRPC, and WebSocket. A saved request contains the protocol target, payload, headers or metadata, authorization, scripts, response history settings, and documentation.
Use Collections when the same request must be sent again, documented, or shared with your team.
Editor layout
The Collections workspace is split into these areas:
| Area | Purpose |
|---|---|
| Collection tree | Stores collections, folders, and requests. Folders can define inherited auth, variables, and scripts. |
| Request header | Contains the request name, protocol or method selector, target URL or endpoint, Save, Send, environment selector, and request tools. |
| Request tabs | Edit the selected request. Tabs change by protocol. |
| Response panel | Shows the latest response, status, duration, response headers, and response body for protocols with a direct response view. |
| Variables panel | Shows every {{variable}} used by the request, where it is defined, and whether it is missing. |
| Diagnostics drawer | Shows console logs, script output, issues, network history, and runtime details. |
Common tabs
Every protocol starts with a Docs tab and ends with Scripts and Settings.
| Tab | Used for |
|---|---|
| Docs | Markdown notes for the request: behavior, input examples, expected response, and ownership notes. |
| Authorization | Request-level auth. A request can inherit auth from its collection or folder, or override it. |
| Headers | HTTP-style headers for HTTP, GraphQL, and WebSocket. |
| Metadata | gRPC metadata key-value pairs. |
| Body | HTTP request body. |
| Query | GraphQL query or mutation text. |
| Variables | GraphQL variables JSON. |
| Message | gRPC message editor. |
| Messages | WebSocket message editor. |
| Schema | GraphQL schema configuration. |
| Service definition | gRPC proto or reflection configuration. |
| Connection | Protocol-specific connection settings. |
| Events | WebSocket message event handling. |
| Scripts | Pre-request and post-response automation for the request. |
| Settings | Protocol options such as TLS validation, redirects, timeouts, response history, reflection, or message limits. |
Protocol tabs
| Protocol | Tabs |
|---|---|
| HTTP | Docs, Params, Authorization, Headers, Body, Scripts, Settings |
| GraphQL | Docs, Query, Variables, Authorization, Headers, Schema, Scripts, Settings |
| gRPC | Docs, Message, Authorization, Metadata, Service definition, Scripts, Settings |
| WebSocket | Docs, Messages, Authorization, Headers, Connection, Events, Scripts, Settings |
HTTP requests
HTTP requests use a method, URL, optional query params, headers, auth, and body.
| Tab | What to configure |
|---|---|
| Params | Query string rows. Enabled rows with a key are appended to the URL. |
| Authorization | Inherited auth or request-specific auth. Use this for bearer tokens, basic auth, API keys, and other supported auth modes. |
| Headers | Request headers. The default Content-Type is application/json. |
| Body | Raw JSON or text, form data, URL encoded data, binary data, or no body depending on body mode. |
| Scripts | Pre-request runs before Send. Post-response runs after a response. |
| Settings | Redirect handling, TLS certificate validation, variable resolution before send, and response history behavior. |
Example HTTP target:
GET {{host}}/api/internal/tokens?limit={{limit}}
GraphQL requests
GraphQL requests are saved as a query or mutation plus variables and HTTP-style request options.
| Tab | What to configure |
|---|---|
| Query | GraphQL query or mutation text. |
| Variables | JSON object used as GraphQL variables. The tab label shows a count when variables are present. |
| Authorization | Auth inherited from collection or folder, or request-specific auth. |
| Headers | Headers for the GraphQL HTTP request. |
| Schema | Schema source, schema URL, or schema definition. |
| Scripts | Before query can prepare headers and variables. After response can assert GraphQL response data or store values. |
| Settings | Operation name and GraphQL-specific execution settings. |
Example:
query Account($id: ID!) {
account(id: $id) {
id
balance
}
}
{
"id": "{{account_id}}"
}
gRPC requests
gRPC requests use service and method selection, metadata, a JSON message, and proto or reflection settings.
| Tab | What to configure |
|---|---|
| Message | JSON request message. |
| Authorization | Auth data that can be translated into request metadata. |
| Metadata | gRPC metadata key-value rows. |
| Service definition | Reflection or service definition source, service name, and method name. |
| Scripts | Before invoke, On message, and After response. |
| Settings | TLS or plaintext mode, TLS server name, reflection timeout, response message size, default value emission, and call timeout. |
Use gRPC requests for service-to-service APIs where a proto service and method define the contract.
WebSocket requests
WebSocket requests model a connection plus one or more messages.
| Tab | What to configure |
|---|---|
| Messages | Text or JSON message payloads to send after connection. |
| Authorization | Handshake auth. |
| Headers | Handshake headers. |
| Connection | WebSocket URL, protocols, timeout, reconnect behavior, and message type. |
| Events | Message lifecycle and received message handling. |
| Scripts | Before connect can prepare URL, headers, and variables. On message can inspect incoming messages. |
| Settings | WebSocket execution options. |
Use WebSocket requests for realtime APIs, subscriptions, and streaming message checks.
Variables and scripts
Requests use {{variable}} templates resolved from collection and folder variables, the selected environment, and script-created values. See Environments and Scripts.
Share docs
Share docs on a collection's Overview publishes the collection's documentation as a read-only web page. Anyone with the link can read it without an account, so you can send API docs to a partner, a customer, or a teammate who doesn't use Requestarium.
The page lists every request in tree order, grouped by folder, with its method, URL, docs (Markdown), headers, and, if you keep Include request bodies as examples on, its body. Header values that look like credentials (Authorization, Cookie, API keys, tokens) are masked unless they are a {{variable}}; check bodies for secrets before you share.
- The page is a snapshot. After you change the collection, open Shared docs and click Update page: the content is replaced and the link stays the same.
- Copy link copies the address. The link is long and random, and the page asks search engines not to index it.
- Turn off link stops the page at once. Sharing again makes a new link, so the old one never works again.
Publishing and turning the link off need write access to the collection. Sharing docs is available on every plan.