@surfaceapi/surface 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -15
- package/package.json +25 -7
package/README.md
CHANGED
|
@@ -1,25 +1,26 @@
|
|
|
1
|
-
# Surface
|
|
1
|
+
# Surface: check a short link before you open it
|
|
2
2
|
|
|
3
|
-
[](https://nova-otter-delta-cloud.grok.me)
|
|
3
|
+
[](https://nova-otter-delta-cloud.grok.me)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[Surface](https://nova-otter-delta-cloud.grok.me) follows the hops on t.co, bit.ly, lnkd.in and youtu.be links (or any https URL) and says **fetch** or **skip**. It never returns the page, so it's one quick round trip.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Python: `pip install surfaceapi` ([clients/python](python))
|
|
7
|
+
Free for the first 1,000,000 requests every month, no card needed. After that: Preflight $0.25, Hop $0.40, Pixel $0.15, Inspect $0.20 per 1,000 requests (USD). Production plan with your own key and meter: $50 CAD/month ([billing](https://nova-otter-delta-cloud.grok.me/billing)).
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
[Get started](https://nova-otter-delta-cloud.grok.me/start) · [Docs](https://nova-otter-delta-cloud.grok.me/docs) · Free API key in 10 seconds: `curl -s -X POST https://nova-otter-delta-cloud.grok.me/v1/keys`
|
|
10
|
+
|
|
11
|
+
## One install for Cursor or Claude (MCP)
|
|
12
|
+
Paste this into your MCP settings. The agent then calls `preflight_url` before it opens a short link.
|
|
12
13
|
```json
|
|
13
|
-
{ "mcpServers": { "surface": { "url": "https://nova-otter-delta-cloud.grok.me/mcp" } } }
|
|
14
|
+
{ "mcpServers": { "surface": { "type": "http", "url": "https://nova-otter-delta-cloud.grok.me/mcp" } } }
|
|
14
15
|
```
|
|
15
16
|
|
|
16
17
|
## JavaScript
|
|
18
|
+
`npm install @surfaceapi/surface`
|
|
17
19
|
```js
|
|
18
|
-
const { Surface } = require(
|
|
19
|
-
const
|
|
20
|
-
const
|
|
21
|
-
|
|
22
|
-
console.log(await
|
|
23
|
-
console.log(await sk.inspect());
|
|
24
|
-
console.log(await sk.hop('abc123'));
|
|
20
|
+
const { Surface } = require('@surfaceapi/surface');
|
|
21
|
+
const { key } = await new Surface().createKey(); // free key
|
|
22
|
+
const s = new Surface({ apiKey: key });
|
|
23
|
+
console.log(await s.preflight('https://youtu.be/jNQXAC9IVRw')); // next: fetch or skip
|
|
24
|
+
console.log(await s.inspect()); // bot, browser, or script
|
|
25
25
|
```
|
|
26
|
+
Python: `pip install surfaceapi`
|
package/package.json
CHANGED
|
@@ -1,13 +1,31 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@surfaceapi/surface",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Check a short link before your agent opens it. Surface client: unwrap t.co/bit.ly/lnkd.in/youtu.be and get fetch or skip. 1M requests/month free.",
|
|
5
5
|
"main": "index.js",
|
|
6
|
-
"files": [
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
"files": [
|
|
7
|
+
"index.js",
|
|
8
|
+
"README.md"
|
|
9
|
+
],
|
|
10
|
+
"engines": {
|
|
11
|
+
"node": ">=18"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"surface",
|
|
15
|
+
"short-link",
|
|
16
|
+
"unwrap",
|
|
17
|
+
"link-check",
|
|
18
|
+
"preflight",
|
|
19
|
+
"mcp",
|
|
20
|
+
"agents",
|
|
21
|
+
"redirect"
|
|
22
|
+
],
|
|
9
23
|
"author": "Surface / Canada Site Ops <canada.site.ops@gmail.com>",
|
|
10
24
|
"license": "MIT",
|
|
11
25
|
"homepage": "https://nova-otter-delta-cloud.grok.me",
|
|
12
|
-
"repository": {
|
|
13
|
-
|
|
26
|
+
"repository": {
|
|
27
|
+
"type": "git",
|
|
28
|
+
"url": "git+https://github.com/Surface-ops/surface.git",
|
|
29
|
+
"directory": "clients/js"
|
|
30
|
+
}
|
|
31
|
+
}
|