Streams the results of a Message Batch as a .jsonl
file.
Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the custom_id
field to match results to requests.
Learn more about the Message Batches API in our user guide
results_url
. This path should not be assumed and may change.Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like beta1,beta2
or specify the header multiple times for each beta.
ID of the Message Batch.
Successful Response
This is a single line in the response .jsonl
file and does not represent the response as a whole.