Overview
Tasks API
Asynchronous jobs of the TextReveal® API: AI Reports, Company ESG Reports, coverage extensions and large exports, with the routes to follow their status and download their results.
Some requests take too long to answer right away: generating an AI Report or a Company ESG Report, adding companies to SESAMm's coverage or exporting a large result.
They run as asynchronous tasks: the API creates the task and returns its task_id, then you follow its status and download its results when it is done.
New to the API? Read the API Overview and Authentication first.
What you can do
| Section | What it covers |
|---|---|
| Follow your tasks | List your tasks, get the status of a task and download its results once it is completed. |
| AI Reports | Generate investor-grade reports on one or several companies, from ESG assessments to supply chain screenings. See Generate AI Reports with the API. |
| Company ESG Report | Get a PDF report on the ESG controversies of a single company: CES, cases or events, breakdown by subrisk and UNGC alignment. See Company ESG Report. |
| Coverage extension | Ask SESAMm to add companies that are not covered yet. See Coverage extension. |
Where to start
- Create a task, for example with Generate Report or Coverage Extension.
- Poll Get Task Status until the task is
completedorfailed. - Get your results with Download Task Results.
Read Tasks to understand how tasks are queued, and check the task limits before creating many of them.