POST
/
extract
curl --request POST \
  --url https://dataextractorai.com/api/v1/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "<string>",
  "schema": {
    "type": "object",
    "properties": [
      {}
    ]
  },
  "webhook_url": "<string>",
  "metadata": {}
}'
{
  "request_id": "<string>",
  "credits_consumed": 123,
  "credits_type": "subscription",
  "status": "pending",
  "success": true,
  "request_data": {
    "schema": {
      "type": "<string>",
      "properties": {}
    },
    "content": "<string>",
    "webhook_url": "<string>"
  },
  "extracted_data": {},
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "processing_time_ms": 2000,
  "webhook_url": "<string>",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
content
string
required
​
schema
object
required

To learn more about JSON Schema standard, check it at https://json-schema.org/learn/getting-started-step-by-step#define-properties

​
webhook_url
string
​
metadata
object

Response

200 - application/json
OK
​
request_id
string
​
credits_consumed
integer
​
credits_type
enum<string>
Available options:
subscription,
credits
​
status
enum<string>
default:pending
Available options:
pending,
processing,
completed,
failed
​
success
boolean
​
request_data
object
​
extracted_data
object | null
​
created_at
string
​
completed_at
string | null
​
processing_time_ms
integer | null
Example:

2000

​
webhook_url
string | null
​
metadata
object