Industry Brief

Generate Industry Brief

GET https://api.main.finalle.ai/industry_brief

Get an AI generated, real-time summarized industry brief.

Headers

Include the X-API-Keyheader in order to authenticate:

{  
    "X-API-Key": "YOUR_API_KEY"
}

Path Parameters

Name	Type	Description
industry*	String (Enum)	The industry to review. Only one industry must be provided. Current supported industries are: energy, communications, industrial, technology, consumption, financial, utilities, basic_materials, real_estate, healthcare

200: OK Success

On success, returns the industry review.

{
    "data": {
        "brief": "string", // The generated industry brief
    },
    "request_id": "YOUR_REQUEST_ID",
    "result": "success"
}

Example

For the request:

https://api.main.finalle.ai/industry_brief?industry=technology

The output is:

{
    "data": {
        "brief": "* Palantir collaborates with Voyager Space to enhance space exploration with AI.\n* BlackBerry surpasses revenue target in Q1 FY25, with strong gross margin.\n* Apple's stock surged post Rosenblatt's Buy upgrade due to AI technology.\n* Nvidia dominates with 155% stock increase in 2024, driven by AI innovation.\n* Micron's Q3 earnings driven by AI server growth and DRAM pricing."
    },
    "request_id": "YOUR_REQUEST_ID",
    "result": "success"
}

400: Bad Request Bad Input

Invalid values were supplied for the API request.

Example:

For the request:

https://api.main.finalle.ai/industry_brief

The output will have 400 response status code with the following response:

{
    "result": "fail",
    "error": "Bad input: 'industry' parameter not provided.",
    "request_id": "YOUR_REQUEST_ID"
}

401: Unauthorized Authorization Invalid

The API key supplied for the API request is invalid.

Example:

For the request:

https://api.main.finalle.ai/industry_brief?industry=technology

With the following header:

{  
    "X-API-Key": "SOME_INVALID_API_KEY"
}

The output will have 401 response status code with the following response:

{
    "result": "fail",
    "error": "Unauthorized api key: SOME_INVALID_API_KEY",
    "request_id": "YOUR_UNIQUE_REQUEST_ID"
}

500: Internal Server Error Interval Server Error

Something went wrong on our server.

The output will have 500 response status code with the following response:

{
    "result": "fail",
    "error": "Internal Server Error",
    "request_id": "YOUR_UNIQUE_REQUEST_ID"
}