Skip to main content
POST
/
extract
Python
import os
from qaip import Qaip

client = Qaip(
    api_key=os.environ.get("QAIP_API_KEY"),  # This is the default and can be omitted
)
response = client.extract(
    schema={},
)
print(response.created)
{
  "created": 123,
  "result": {}
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
schema
object
required

JSON Schema for the data to be extracted.

​
tags
string[]
​
tag_ids
string[]
​
tag_filter_logic
enum<string>
default:OR

Logical operator for combining filter conditions

Available options:
AND,
OR
​
source_types
enum<string>[]

The type of the source

Available options:
crawl,
local_file,
google_drive,
github,
notion
​
file_types
enum<string>[]

The type of the source file

Available options:
html,
pdf,
ppt,
pptx,
pptm,
doc,
docx,
docm,
xls,
xlsx,
xlsm,
md,
txt,
jsonl,
png,
jpg,
webp,
heic,
heif,
wav,
mp3,
aiff,
aac,
m4a,
ogg,
flac,
mp4,
mpg,
mov,
avi,
flv,
webm,
wmv,
3gp,
notion_page
​
date_from
integer

Start date for content search (Unix timestamp in seconds)

Required range: x >= 1735639200
​
date_to
integer

End date for content search (Unix timestamp in seconds)

Required range: x >= 1735639200
​
domains
string[]
​
metadata
object

(reserved for future use) Filter group with nested structure. Supports combining filters with AND/OR logic.

​
source_metadata
object

Filter by individual source/file metadata from source_metadatas table

​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
prompt
string

Additional prompt for the LLM (optional, if not specified, a default prompt in Japanese will be used).

​
use_related
boolean

Whether to search for and use related content

​
related_filter
object

Response

Successful extraction

​
created
integer
required

抽出実行時刻（Unix timestamp）

​
result
object
required

Extraction result as a JSON object conforming to the provided schema.