Skip to main content
This guide helps you make your first API call to transform natural language questions into structured, validated records with source citations.

Before you start

Before you begin, make sure you meet these prerequisites:
  • An API key (obtain one through Book a demo page)
  • Basic understanding of REST APIs
  • Your preferred programming language and HTTP client
  • Basic knowledge of JSON data format

Steps

1

Set up your environment

Install the HTTP client library for your programming language:
# cURL is typically included in your system
# To check, open the terminal and type the following:
curl --version
2

Create a job

Submit a natural language query to create a new processing job:
curl -X POST https://catchall.newscatcherapi.com/catchAll/submit \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Tech company earnings this quarter",
    "context": "Focus on revenue and profit margins",
    "summary_template": "Company [NAME] earned [REVENUE] in [QUARTER]"
  }'
Replace YOUR_API_KEY_HERE with your actual API key.
You receive a response with a job ID:
{
  "job_id": "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
}
Use this job_id to check the status and retrieve results.
3

Check job status

Wait 1-2 minutes, then check the processing status. Poll this endpoint every 30-60 seconds until the status is job_completed:
curl -X GET https://catchall.newscatcherapi.com/catchAll/status/af7a26d6-cf0b-458c-a6ed-4b6318c74da3 \
  -H "x-api-key: YOUR_API_KEY_HERE"
The response shows the current processing stage:
{
  "job_id": "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
  "status": "data_fetched"
}
Jobs progress through statuses from pending to job_completed. The list of all job statuses available in the Introduction > Job statuses.Processing typically takes 10-15 minutes.
4

Retrieve results

Once the status is job_completed, retrieve the structured records:
curl -X GET https://catchall.newscatcherapi.com/catchAll/pull/af7a26d6-cf0b-458c-a6ed-4b6318c74da3 \
  -H "x-api-key: YOUR_API_KEY_HERE"
5

Review the response

The API returns structured records according to LLM-generated enrichment schema:
The field names in the enrichment object are LLM-generated and may vary event for the same inputs. The example above shows one possible structure for earnings queries.

What’s next

Now that you’ve made your first calls to the CatchAll API:
  1. Read Understanding dynamic schemas to learn how to handle variable response structures in your code.
  2. Explore the API Reference for detailed endpoint documentation.
  3. Review the Introduction to understand how the processing pipeline works.
Need help? Contact our support team at support@newscatcherapi.com