HomeHelp & SupportAPI DocumentationOrgSearch › Request Parameters

Request Parameters

Below is a list of the request parameters required to perform operations with the Mojeek OrgSearch API. For parameters related to retrieving search results, please see the Search API documentation.

You can see our response codes on the response codes page.

Endpoints:

The endpoints listed below should be appended to https://www.mojeek.com/api/orgse

Add a URL

Adds a URL to the Organisation's list of pages and initiates a crawl of the page if it hasn't already been indexed by Mojeek.

/url

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to add.
  • pubdate timestamp
    Published date in UNIX timestamp format.
  • categories string
    Pipe separated list of case-sensitive category strings e.g. cat1{|cat2|cat3}.
    Note: there is a string limit on categories of 63 bytes per category, and a limit of 16 categories per URL.
  • live boolean
    Make this url live.
    Valid options: [0|1]. Default = 1.

API Request example:

curl --request POST "https://www.mojeek.com/api/orgse/url" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "pubdate=1634529771" \
    -d "categories=cat1|cat2|cat3" \
    -d "live=1"

Add Categories to a URL

Appends provided categories to the URLs existing categories or adds them if none already exist.

/url/categories

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to add categories to.
  • categories string
    Pipe separated list of case-sensitive category strings to add e.g. cat1{|cat2|cat3}.
    Note: there is a string limit on categories of 63 bytes per category, and a limit of 16 categories per URL.

API Request example:

curl --request POST "https://www.mojeek.com/api/orgse/url/categories" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "categories=cat1|cat2|cat3"

Replace URL Categories

Replaces all existing categories for this URL with the new ones provided.

/url/categories

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to replace the categories for.
  • categories string
    Pipe separated list of case-sensitive category strings e.g. cat1{|cat2|cat3}.
    Note: all existing categories for this URL will be replaced. There is a string limit on categories of 63 bytes per category, and a limit of 16 categories per URL.

API Request example:

curl --request PATCH "https://www.mojeek.com/api/orgse/url/categories" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "categories=cat1|cat2|cat3"

Delete Categories from a URL

Deletes one or more categories from a URL.

/url/categories

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to remove categories from.
  • categories string
    Pipe separated list of case-sensitive category strings to remove e.g. cat1{|cat2|cat3}.

API Request example:

curl --request DELETE "https://www.mojeek.com/api/orgse/url/categories" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "categories=cat1|cat2|cat3"

Update the published date of a URL

Changes the published date of a URL to the new one provided.

/url/pubdate

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to update the published date for.
  • pubdate timestamp
    Published date in UNIX timestamp format.

API Request example:

curl --request PATCH "https://www.mojeek.com/api/orgse/url/pubdate" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "pubdate=1634529771"

Update the live status of a URL

Changes the live status of a URL in order to show/hide it in search results.

/url/live

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to update the live status for.
  • live boolean
    Set the live status of this URL. Setting it to 0 will hide the URL from search results.
    Valid options: [0|1].

API Request example:

curl --request PATCH "https://www.mojeek.com/api/orgse/url/live" \
    -d "api_key=API_KEY" \
    -d "url=URL" \
    -d "live=1"

Refresh a URL

This marks a URL to be re-crawled and re-indexed.

/url/refresh

  • api_key string
    Your unique api key to retrieve results.
  • url string
    URL to re-crawl and re-index.

API Request example:

curl "https://www.mojeek.com/api/orgse/url/refresh?api_key=API_KEY&url=URL"

Further reading: OrgSearch Response Codes