Tools

Extract structured data from Markdown using a JSON schema.

This endpoint processes Markdown content and extracts structured data according to the provided JSON schema.

For EU users, use this endpoint:

`https://api.va.eu-west-1.landing.ai/v1/ade/extract`.
post/v1/ade/extract

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body multipart/form-data

modelstring nullable

The version of the model to use for extraction. Use extract-latest to use the latest version.

markdown_urlstring nullable

The URL to the Markdown file to extract data from.

schemastring required

JSON schema for field extraction. This schema determines what key-values pairs are extracted from the Markdown. The schema must be a valid JSON object and will be validated before processing the document.

strictboolean

If True, reject schemas with unsupported fields (HTTP 422). If False, prune unsupported fields and continue. Only applies to extract versions that support schema validation.

Response

Successful Response

extractionobject required

The extracted key-value pairs.

extraction_metadataobject required

The extracted key-value pairs and the chunk_reference for each one.

Changes

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • warning

      removed the request property