🚧

Notice

If the payload is less than 32 KB use v1 of the bulk endpoints (e.g. Predict for Transition Bulk v1 and Title Parser Bulk v1).

If the payload is larger than 32 KB use v2 of the bulk endpoints (e.g. Predict for Transition Bulk v2 and Title Parser Bulk v2).

This endpoint only applies to v2 bulk endpoints.

User question: How do I access the results from a bulk endpoint?

All input params are the same as v1. There's a 20 MB payload limit so gzip if sending a large request. The new endpoint will parse the input, validate types etc. and respond with a result set ID and link to check status.

{
"id": "01800446-efb1-88af-9e7e-5f487977fbbc",
"link": "/v1/result-sets/01800446-efb1-88af-9e7e-5f487977fbbc"
}

The result set resource is also new. It's the link provided in the return of the bulk API. You can poll here for state updates. An in-process task will look like this:

{
"file_url": null
"id": "01800446-efb1-88af-9e7e-5f487977fbbc",
"state": "processing(predicting)"
}

When the task is complete, it will be in "state"="done" and will include a presigned download link that's good for 5 mins. If it expires, just GET /v1/result-sets/{result_set_id} for a fresh link.

A completed processing looks like this:

{
"file_url": "https://bulk-data-api.s3.amazonaws.com/u-7/01800446-efb1-88af-9e7e-5f487977fbbc.results?AWSAccessKeyId=ASIATAFHBSD7VKJLO6H3&Signature=v%2BHRsdNmMJ67Mb5vrAYSE8Qo4Vs%3D&x-amz-security-token=IQoJb3JpZ2luX2VjECYaCXVzLWVhc3QtMSJHMEUCIExmQ2oKK9LrUwEDylUwJBcpbL3usEZeYjfiJnrvgd1TAiEAxmimZyakKdj9IkAEgk2V3JgONPuvGZ76Spcu%2FRL0aBoq%2FAMIv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARABGgwyMDY1MDg3NTcyNDciDPPpF2Hq7WaRDl4vQyrQA6lsti6mbWsjtkFdHw7gKeyunx5SakHC6dvNbh%2BvsNYHoQmxsDTlCf%2BKrI%2BV0Qzh7DNrkjMneV%2BWb3RwC1tPCiAXwSSl50i387gmT%2BvrLtZvDri%2BB8m3kECIGY%2BxJuFf0Xb%2FG4TTy3OEQHQQwz62%2B%2F6rx25%2Bg1makcFcc3OztcwVBgZGHbmEdcYwWzDD%2F3sWr3bHMRNjCU5Yhlr%2FhO8MZHoafoeTPCi%2B4PvKICwY7PXfzeJsbB6kNiRjF8oubJdS3jE2Z%2BpobXGDd%2FNXpVFXly%2FiMwVVxN0yDqoidXspSc3Kuu71Qx2dbSJCCJQDLqWfXTdtXu%2Fks8JOXaPX3FJQCmTj7jXIZScS4JglRXQDEiBDhoj4AtoLvgd08%2FmItyBRkoVEHQW0ZkqTLrEclJvTswR0Y8ptx2geDpEmmn9GfqAWx%2BYHgaztIxg%2F0reT2GX4tKX8KThUlJLsErHckKYe6miZTWIEI1VIEhK3plQtH9ByppCFDo9ABTa3TRhmnJp5j9s0eGXZy9fmBDdiJXHmhsnBaRlI9NZIWkD6ty8huABzinlWKQJgmYEl%2FawNrpiddmDdMa1PJVaUmUDqPtxstebyiic%2BK8qwANofV4JgA0gxMIXSu5IGOqUBVwEmr7B01KkYN8SenFnm9PEctYusJv9sN90jua7kyJI0J%2Bama6rpU148pEBdkTXavhOUh2h990QcgwzXbcKgbHz5c3S3KT4xkvLnVwfYdQ7%2Bgfb5AxGWPye3z0x5lgspHJLVoYSOaENr0PK4jPW5v2CzFh4Br4VbN10bsb%2FD2aD0IiBHGUqMoPq%2FhUWJUiIokjyQ6rZvwIuY4SZhWdc8%2BXeIunmY&Expires=1649339535",
"id": "01800446-efb1-88af-9e7e-5f487977fbbc",
"state": "done"
}

❗️

Important

The result files are gzipped (the extension is ".results", please treat it as if it were ".results.gz")

Language
Authentication
Header
Click Try It! to start a request and see the response here!