Skip to main content
POST
/
v1
/
jobs
/
extract-properties
Extract Properties
curl --request POST \
  --url https://api.aryn.cloud/v1/jobs/extract-properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "properties": [
    {
      "name": "<string>",
      "field_type": "<string>",
      "default": "<any>",
      "description": "<string>",
      "examples": [
        "<any>"
      ]
    }
  ]
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
docset_id
string
required

The ID of the DocSet to extract properties from

Body

application/json

A Schema describing the fields to extract from the DocSet

​
properties
SchemaProperty · object[]
required

A list of properties belong to this schema.

Response

Successful Response

The response is of type any.