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:
2
Create a job
Submit a natural language query to create a new processing job:You receive a response with a job ID:Use this
Replace
YOUR_API_KEY_HERE
with your actual API key.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 The response shows the current processing stage:Jobs progress through statuses from
job_completed
: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: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:- Read Understanding dynamic schemas to learn how to handle variable response structures in your code.
- Explore the API Reference for detailed endpoint documentation.
- Review the Introduction to understand how the processing pipeline works.
Need help? Contact our support team at support@newscatcherapi.com