How to use the Query Builder#

The APITube Query Builder is an interactive form on the documentation site at docs.apitube.io/platform/news-api/query-builder. You pick an endpoint, fill in filter fields, and it writes the matching request URL and a ready-to-run cURL command for you — so you never have to hand-type parameter names or remember the dot-notation syntax. Fill a field, and the generated request updates instantly below the form.

It is the fastest way to turn “I want English articles about AI with positive sentiment” into a working request. You leave with a URL you can paste into code and a cURL command you can run in a terminal.

How do you build a request with the Query Builder?#

Start at the top of the form and work down. There are three things that matter most:

1. Pick the endpoint. The endpoint dropdown defaults to Everything (/v1/news/everything), the general search endpoint, and also offers Top Headlines, Story, Category, Topic, Industry, Entity, Trends and Single Article.
2. Fill in filter fields. Type your title terms, choose a language, set a sentiment polarity, and so on. Empty fields are ignored — only the fields you fill become part of the request.
3. Read the generated request. As you edit, the builder rewrites the request URL and cURL command underneath. For example, setting Title to AI and Sentiment Polarity to positive produces:

https://api.apitube.io/v1/news/everything?title=AI&sentiment.overall.polarity=positive&api_key=YOUR_API_KEY

Notice the form uses friendly labels but the URL uses the real API parameter names — the builder maps each field to its dot-notation parameter, so Sentiment Polarity becomes sentiment.overall.polarity, Language Code becomes language.code, and Source Rank Min becomes source.rank.opr.min. That mapping is the whole point: you learn the API by watching the URL build itself.

Which endpoints and filters can you use?#

The endpoint dropdown covers nine read endpoints: Everything, Top Headlines, Story, Category, Topic, Industry, Entity, Trends and Single Article. The filter fields are grouped into logical sections — Endpoint, Title, Language, Categories, Topics, Industries, Entities, Persons, Locations, Organizations, Brands, Authors, Sentiment, Media, Source, Date Range, Sorting, Pagination, other filters, and Export — so a parameter is easy to find by area.

A few input conventions carry straight through to the URL:

• Multiple values go in one field separated by commas, e.g. language.code=en,fr,de or title=Bitcoin,Ethereum,Cryptocurrency.
• Exact phrases use quotes, e.g. title="Breaking News".
• The title pattern field is a case-insensitive substring (LIKE) match, not a regular expression — characters like ^, . and * are treated as literal text.
• Sorting fields fill sort.by and sort.order; if you leave them blank the API sorts by published_at in desc order (newest first).

For the full meaning of every field, the builder links to the Parameters Reference, which stays the canonical source for parameter syntax.

How do you copy the URL or cURL command?#

Below the form the builder shows two outputs with copy buttons: Copy URL puts the full request URL on your clipboard, and Copy cURL copies a curl -X GET "…" command wrapping that same URL. Paste the URL into your code (a fetch, a requests.get, an SDK call) or run the cURL command straight in a terminal.

If you have not entered a key, the builder inserts the placeholder YOUR_API_KEY in the copied request, so you can safely share or paste it and swap the key in later. Enter a real key only to use the Test Query button — it opens the request URL, with your key attached, in a new browser tab so you can see the raw JSON response. Because Test Query fires a genuine call to the News API, a live key spends quota just like any other request (see how to combine multiple filters in one request for building the filters, and where to find your API key).

Common Questions#

• Where does the Query Builder live?
• Is the Query Builder the same as the Playground?
• Is my API key safe in the Query Builder?
• Do I need an API key to build a request?

Where does the Query Builder live?#

The Query Builder is a page in the APITube documentation, at docs.apitube.io/platform/news-api/query-builder — not inside the dashboard. It needs no login: anyone can open it, build a request, and copy the URL or cURL. That makes it handy for drafting a request while you read the docs, then dropping the result into your own code.

Is the Query Builder the same as the Playground?#

No — they are two different tools for two moments. The Query Builder (in the docs) assembles a request and hands you the URL and cURL; its Test Query button opens the raw response in a new tab. The API Playground (in your dashboard) runs the request with one of your workspace keys and renders the JSON response inline, with visual cards and headers. Use the Query Builder to draft and copy a request quickly; use the Playground to run and inspect responses against your account.

Is my API key safe in the Query Builder?#

The key you type stays in your browser — it is only used to assemble the request and to open the Test Query tab, and it is not sent to the documentation server. One thing to watch: once you enter a real key, the generated URL and cURL contain it, so if you then click Copy URL or Copy cURL the copied text includes your key. Don’t paste a copied request that contains your live key into a public place — clear the key field first, or rely on the YOUR_API_KEY placeholder.

Do I need an API key to build a request?#

No. You can pick an endpoint, fill every filter, and copy a complete URL or cURL without ever entering a key — the builder simply writes YOUR_API_KEY where the key goes. A key is required only for the Test Query button, which needs a real key to make the live call. This lets you design and share a request first, then add authentication when you are ready to send it.