Tools

ADE Extract

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

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

Changed in 14 of the 30 revisions of this API.12135

    • added the new optional request property strict

      new-optional-request-property

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

      response-media-type-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property metadata/warnings to the response with the 200 status

      response-optional-property-added

    • removed the request property strict

      request-property-removed

    • added the new optional request property strict

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security Basic Auth was removed from the API

      api-security-removed

    This revision also has 106 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eeb4eb7952ab54See the full diff
    • removed the media type application/json from the request body

      request-body-media-type-removed

    • removed subschema #1 subschema #2 from the request body oneOf list

      request-body-one-of-removed

    • the request property markdown became not nullable

      request-property-became-not-nullable

    • the request property markdown_url became not nullable

      request-property-became-not-nullable

    • the request property model became not nullable

      request-property-became-not-nullable

    • the endpoint scheme security Basic Auth was added to the API

      api-security-added

    • request property markdown list-of-types was widened by adding types null to media type multipart/form-data

      request-property-list-of-types-widened

    • request property markdown_url list-of-types was widened by adding types null to media type multipart/form-data

      request-property-list-of-types-widened

    • request property model list-of-types was widened by adding types null to media type multipart/form-data

      request-property-list-of-types-widened

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added subschema #1 subschema #2 to the request body oneOf list (media type: application/json)

      request-body-one-of-added

    • added subschema #1 subschema #2 to the request body oneOf list (media type: multipart/form-data)

      request-body-one-of-added

    • the request property markdown became nullable (media type: multipart/form-data)

      request-property-became-nullable

  • 73d13502c1d033See the full diff
    • request property markdown list-of-types was narrowed by removing types null from media type multipart/form-data

      request-property-list-of-types-narrowed

    • request property markdown_url list-of-types was narrowed by removing types null from media type multipart/form-data

      request-property-list-of-types-narrowed

    • request property model list-of-types was narrowed by removing types null from media type multipart/form-data

      request-property-list-of-types-narrowed

    • added the media type application/json to the request body

      request-body-media-type-added

    • the request property markdown_url became nullable

      request-property-became-nullable

    • the request property model became nullable

      request-property-became-nullable

    • the endpoint scheme security Basic Auth was removed from the API

      api-security-removed

    This revision also has 106 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eeb4eb7952ab110See the full diff
    • the metadata response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • the endpoint scheme security Basic Auth was added to the API

      api-security-added

    • added the optional property metadata/fallback_model_version to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/schema_violation_error to the response with the 200 status

      response-optional-property-added

    • removed ExtractMetadata from the metadata response property allOf list for the response status 200

      response-property-all-of-removed

    • added the required property metadata/credit_usage to the response with the 200 status

      response-required-property-added

    • added the required property metadata/duration_ms to the response with the 200 status

      response-required-property-added

    • added the required property metadata/filename to the response with the 200 status

      response-required-property-added

    • added the required property metadata/job_id to the response with the 200 status

      response-required-property-added

    • added the required property metadata/org_id to the response with the 200 status

      response-required-property-added

    • added the required property metadata/version to the response with the 200 status

      response-required-property-added

    • added the optional property metadata/allOf[subschema #1: ExtractMetadata]/fallback_model_version to the response with the 200 status

      response-optional-property-added