/dbpedia/resources/search

POST /api/dbpedia/resources/search

Price: 1 credit

Search DBpedia resources by keyword (resolve a name to a DBpedia resource)

How to use it

Search DBpedia resources by keyword — the entry point that turns a name into a DBpedia resource. Returns matching resources with their resource name and URI, label, short description, ontology types and categories, reference count and relevance score. Pass an ontology class URI in 'type' to restrict results (e.g. only people or only cities). Use it before any get-by-id call when you only know the name of a thing, not its resource id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Text to search across DBpedia resource labels and abstracts (minLength: 1)
• type string nullable — Restrict results to a single DBpedia ontology class URI (examples: "http://dbpedia.org/ontology/Person", "http://dbpedia.org/ontology/City")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "DbpediaSearchResult")
• id string nullable
• uri string required
• label string nullable
• description string nullable
• types array (default: [])
• type_names array (default: [])
• categories array (default: [])
• redirects array (default: [])
• ref_count integer nullable
• score number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.