Skip to main content
A Supplier Dossier is a detailed report that provides a comprehensive overview of a supplier’s information as well as the market landscape in which they operate. It contains 3 main sections:
  • Company Profile: Company details, corporate structure, SWOT analysis and more.
  • Latest: Latest news, sentiment analysis, and summary of recent events.
  • Market Insights: The Market landscape in which the supplier operates, including market size, Porter’s Five Forces analysis, and more.

​
Retrieving a Supplier Dossier

Typically, dossiers are viewed on our Supplier Dossier platform, but you can also retrieve them programmatically using our API in order to integrate them into your own applications:
1

List Dossiers

With the GET /v2/collections/{collectionId}/dossiers/ endpoint, you can retrieve a list of dossiers in a collection.
curl -X GET '<host>/v2/collections/{collectionId}/dossiers/' \
-H 'x-api-key: <api_token>'
The response will contain a list of dossiers, each with its ID and other metadata:
{
    "metadata": {
        "pagination": {
            "totalItems": 1,
            "totalPages": 1,
            "currentPage": 1,
            "pageSize": 10
        },
        "filters": {},
        "sort": [
            {
                "field": "createdAt",
                "order": "desc"
            }
        ]
    },
    "data": [
        {
            "agentId": "06cc42ffec804a45bbe0389aab5beeda7a4ca0add2ab67cbe643203f803f3045",
            "query": "SpaceX",
            "agentType": "supplierDossier",
            "createdBy": "02c6ce75-f2e1-4ce2-b3f7-29159d9ce9d9",
            "createdAt": "2025-07-18T14:18:51.000Z",
            "lastModifiedAt": null,
            "lastTaskId": "c91d6d75-f553-453c-b101-13f47f681cf1",
            "lastTaskStatus": {
                "taskId": "c91d6d75-f553-453c-b101-13f47f681cf1",
                "createdAt": "2025-07-18T14:18:51.000Z",
                "success": true,
                "status": "COMPLETED",
                "lastReportedAt": "2025-07-18T14:37:34.000Z",
                "lastReportedBy": "python-llm-agent-deployment-dev-86c9664c49-x5s6h"
            }
        }
    ]
}
2

Check status of a dossier

Since the dossiers takes some time to generate, you may want to check that the dossier is ready before displaying it to the user.You can do this by checking the lastTaskStatus field in the dossier response. If the status is COMPLETED, then the dossier is ready to be viewed.

Displaying the dossier

You can either
  • display the dossier with your own UI component using the raw data, or
  • embed our pre-built UI components in an iFrame.
  • Retrieve the dossier by ID
  • Embed our UI components
You can retrieve a dossier using the GET /v2/collections/{collectionId}/dossiers/{agentId} endpoint:

Retrieving a dossier by ID

The agentId is the unique identifier for the dossier, which you can get from the list of dossiers.Each dossier data structure has the field agentId which can be used below.
curl -X GET '<host>/v2/collections/{collectionId}/dossier/{agentId}' \
-H 'x-api-key: <api_token>'
See the dossier endpoint for more details on the dossier structure.