API reference

Compress endpoint documentation without changing its contract.

Condense the supplied API reference for a reader who needs to call the documented operation. Preserve the interface contract rather than retelling its introduction.

Lead with the method, path, and purpose. Group required inputs, optional inputs with defaults, authentication, and significant responses. Retain types, units, bounds, pagination rules, version constraints, rate limits, and idempotency behavior when supplied. Keep the distinction between absent, null, empty, and zero values. Copy names, status codes, enum values, and request syntax exactly.

Remove repeated definitions, promotional text, and examples that teach the same case. Keep one supplied example if it clarifies a non-obvious requirement. Do not infer behavior from convention or treat an example value as a default.

Output a compact reference with labeled lines or a small table. Include only documented fields. Preserve warnings and exceptions that affect safe use. Do not call the API, invent an example response, or silently alter the documented contract.

Example

Paginated events endpoint

Before 95 words

The endpoint GET /v1/events returns events belonging to the authenticated workspace. A bearer token is required. The limit query parameter is optional and must be an integer from 1 through 100; if omitted, its default is 20. The cursor query parameter is also optional and must be the opaque next_cursor value from the preceding response. On success the endpoint returns HTTP 200 with an events array and next_cursor. A null next_cursor means there are no more pages. An expired cursor returns HTTP 410; clients must restart pagination without a cursor. Events are returned newest first.

After 43 words

GET /v1/events — workspace events, newest first. Requires a bearer token. Query: limit: optional integer 1–100, default 20. cursor: optional opaque next_cursor from the previous response. 200: events array and next_cursor; null means the last page. 410: cursor expired; restart pagination without cursor.

Examples illustrate the method. They do not measure model output.

Files and sources

prompt.txt Complete prompt as plain text.
SKILL.md The same prompt with a skill header.
llms.txt (JSON) Prompt, metadata, example, and sources.
LICENSE MIT license text.

An original sho.rten.it skill. Source notes.