apyhub
▣ DATA EXTRACTION · DEVELOPER TOOLS

URL Detector API

What it does

URL Detector finds URLs in plain text and returns them for further processing. Send a block of content in the content field, submit the job, then poll the job status endpoint with the returned job_id.

When the job completes successfully, the result includes a result array of detected URL objects. Each object contains the full url, including its scheme or protocol, and the protocol value itself. Job status is reported as queued, running, success, or failed, so you can build async workflows around large documents or high-volume text feeds.

Use URL Detector when you need to scan user-generated content, emails, support tickets, scraped pages, or logs for links before storage, enrichment, or validation. It is useful anywhere you need to extract URLs without writing your own parser.

The API is straightforward: one request to submit text, one request to check status, and a structured response that gives you the detected links back.

▣ ENDPOINT 01 / 02
POST
URLs Detector - Submit Job
https://api.eu.apyverse.com/sharpapi/detect-urls

QUICKSTART

GUIDE

Quickstart

Submit text to detect any URLs in it.

curl -X POST "https://api.eu.apyverse.com/sharpapi/detect-urls" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"Check https://example.com and http://openai.com for details."}'

What you'll get back

Returns a JSON object with a job_id string and a status_url string. job_id is the unique identifier for the submitted job, and status_url is the URL to poll for the job's status and result.

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "https://example.com/jobs/550e8400-e29b-41d4-a716-446655440000"
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
The content from which URLs are to be detected.

About this endpoint

What it does

Submits a job to detect URLs from the provided content. The response returns a job identifier and a status URL you can poll for completion.

Request Body

ParameterTypeMandatoryDescription
contentStringYesThe content from which URLs are to be detected.

Response

Returns a JSON object with two string fields: job_id and status_url. job_id is the unique identifier of the submitted job, and status_url is the URL to poll for the job's status and result.

ParameterTypeMandatoryDescription
job_idStringNoThe unique identifier of the submitted job. Format: UUID.
status_urlStringNoURL to poll for the job's status and result. Format: URI.

Notes

This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract the job identifier from job_id.

Body

Name
Type
Description
bodyREQUIRED
object
—
▣ ENDPOINT 02 / 02
GET
URLs Detector - Check Job Status
https://api.eu.apyverse.com/sharpapi/detect-urls/job/status/:job_id

QUICKSTART

GUIDE

Quickstart

Check the status of a URL-detection job by replacing :job_id with your job's UUID.

curl -X GET "https://api.eu.apyverse.com/sharpapi/detect-urls/job/status/:job_id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data object. Inside data, you'll get id (the job UUID), type (for example, api_job_result), and attributes with type, result, and status.

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "api_job_result",
    "attributes": {
      "type": "content_detect_urls",
      "result": [],
      "status": "success"
    }
  }
}
TRY ITLIVE · 1 ATOM
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Checks the status of a previously submitted URL-detection job by job ID and returns the job record, including its current status and any detected URL results when available.

Path Parameter(s)

AttributeTypeMandatoryDescription
job_idStringYesThe job identifier, in UUID format.

Response

Returns a JSON object with a data object field. data contains the job id string, type string, and an attributes object with type string, result array, and status string.

AttributeTypeMandatoryDescription
dataObjectNoThe job result wrapper. Contains id, type, and attributes.
data.idStringNoThe job identifier, in UUID format.
data.typeStringNoThe response object type.
data.attributesObjectNoThe job attributes wrapper. Contains type, result, and status.
data.attributes.typeStringNoThe job result type.
data.attributes.resultObject ArrayNoThe detected URLs returned for the job. Each item contains url and protocol.
data.attributes.result[].urlStringNoThe detected URL, including its scheme/protocol.
data.attributes.result[].protocolStringNoThe protocol/scheme of the detected URL, such as http, https, ftp, mailto, tel, or ssh.
data.attributes.statusENUMNoThe job status. Allowed values: running, failed, queued, success.

Path parameters

Name
Type
Description
job_idREQUIRED
string
—
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.

Product
CatalogPricingQuickstartBecome a providerStatus (opens in new tab)
Company
AboutBlogCareers (opens in new tab)Contact
Legal
Terms of ServicePrivacy PolicyProvider terms
© 2026 APYHUB · BUILT FOR DEVELOPERS