POST /v2/parse
Parse a document image into structured output. Use output_format to select
blocks or markdown (default).
Currently supports document.type = image_url only (data URI or remote http(s)
image URL). PDF / file URL inputs are not yet supported.
Image limits: 20 MB file size; 50 megapixels or 200 MB decoded (whichever is exceeded first).
Servers
- https://api.cohere.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Client-Name |
String | No |
The name of the project that is making the request. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
output_format |
String | No |
Selects the page payload shape in the response. Defaults to
Valid values:
Default value: "markdown" |
document |
Object | Yes |
Document to parse. Currently only |
document.type |
String | Yes |
Discriminator for the document payload. Valid values:
|
document.image_url |
String | Yes |
Image URL or base64 data URI to parse. Limits:
|
model |
String | Yes |
The name of a compatible Cohere parse model. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.