POST
/
v1
/
ade
/
extract
cURL
curl -X POST 'https://api.va.landing.ai/v1/ade/extract' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'schema=@{"type": "object", "properties": {"field1": {"type": "string"}, "field2": {"type": "string"}}, "required": ["field1", "field2"]}' \
  -F 'markdown=@markdown.md'
{
  "extraction": {},
  "extraction_metadata": {},
  "metadata": {
    "filename": "<string>",
    "org_id": "<string>",
    "duration_ms": 123,
    "credit_usage": 123,
    "version": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Your unique API key for authentication.

Get your API key here: https://va.landing.ai/settings/api-key.

If using the EU endpoint, get your API key here: https://va.eu-west-1.landing.ai/settings/api-key.

Body

multipart/form-data
​
schema
string
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.

​
markdown
file | null

The Markdown file to extract data from.

​
markdown_url
string | null

The URL to the Markdown file to extract data from.

Response

Successful Response

​
extraction
object
required

The extracted key-value pairs.

​
extraction_metadata
object
required

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

​
metadata
object
required

The metadata for the extraction process.