1ms.tools
APIs

Link Preview API

Retrieve link preview metadata for bookmarks, content management and message displays.

1 credit per successful task10 external calls / minute / account
Get an API keyTry the online toolAPI docs

Integration use cases

Use it for content aggregation, bookmarks and editorial review. Submit a page URL for preview metadata, then choose your own presentation and preserve the source and audit record as needed.

Request example

Replace the example key with one created in your console. The input demonstrates integration; consult the API documentation for all fields and validation rules.

POST /openapi/tools/link-preview/execute
curl 'https://1ms.tools/openapi/tools/link-preview/execute' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: YOUR_UNIQUE_REQUEST_ID' \
  -d '{"url":"https://example.com"}'
Asynchronous response and result retrieval

An accepted request returns HTTP 202 and job metadata. The job has not completed yet; this example shows commonly used fields.

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "result": null,
    "creditCost": 1,
    "pollAfterMs": 6000,
    "statusUrl": "/openapi/jobs/JOB_ID"
  }
}

Wait at least six seconds before polling with the same key. Read result on succeeded, or error on failed or canceled.

curl 'https://1ms.tools/openapi/jobs/JOB_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Detected previews can differ from a social platform’s final rendering. Platform caching and crawler rules are outside this API’s control.

API integration questions

Use Authorization: Bearer YOUR_API_KEY or X-API-Key. External endpoints require a valid key; browser cookies cannot replace it. Keep keys on a server or in a trusted application environment.

Creating a job reserves 1 credit, finalized on success. Invalid input or insufficient credits creates no job; failure, timeout or cancellation of a queued job refunds the reservation. Polling costs no credits but counts toward the rate limit.

This endpoint uses asynchronous jobs, returning HTTP 202 and a job ID first. Poll the returned statusUrl and read result on success. Use Idempotency-Key for submission retries.

Each account can make 10 external business requests per calendar minute, shared by all keys and counted separately from web requests. Polling, uploads and execution all count; respect Retry-After on HTTP 429.