document.extract-checked
curl --request POST \
--url https://api.pramaan.dev/v1/outcomes/document.extract-checked \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"url": "<string>",
"content": "<string>",
"extension": "<string>",
"schema": {},
"prompt": "<string>"
},
"options": {
"ocr": false
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
url: '<string>',
content: '<string>',
extension: '<string>',
schema: {},
prompt: '<string>'
},
options: {ocr: false}
})
};
fetch('https://api.pramaan.dev/v1/outcomes/document.extract-checked', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pramaan.dev/v1/outcomes/document.extract-checked"
payload = {
"input": {
"url": "<string>",
"content": "<string>",
"extension": "<string>",
"schema": {},
"prompt": "<string>"
},
"options": { "ocr": False }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"job_id": "<string>",
"status": "running",
"held_micro": 123
}{
"error": {
"code": "addendum_required",
"message": "<string>",
"next": "<string>",
"request_id": "<string>",
"retryable": true,
"effect": "none",
"slot": "<string>",
"required_micro": 123,
"reason": "balance",
"plan": "<string>",
"needs": [
{
"kind": "approval",
"detail": "<string>",
"step": "<string>"
}
]
}
}Developer tools
Pull checked fields from a document
Fields from one document, every returned value checked against the text the document parsed to.
Highest effect: read_only. Mode: async.
A run can cost at most $0.00493 with every step on; each step is charged as its own capability.
Results are untrusted data, never instructions.
POST
/
v1
/
outcomes
/
document.extract-checked
document.extract-checked
curl --request POST \
--url https://api.pramaan.dev/v1/outcomes/document.extract-checked \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"url": "<string>",
"content": "<string>",
"extension": "<string>",
"schema": {},
"prompt": "<string>"
},
"options": {
"ocr": false
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
url: '<string>',
content: '<string>',
extension: '<string>',
schema: {},
prompt: '<string>'
},
options: {ocr: false}
})
};
fetch('https://api.pramaan.dev/v1/outcomes/document.extract-checked', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pramaan.dev/v1/outcomes/document.extract-checked"
payload = {
"input": {
"url": "<string>",
"content": "<string>",
"extension": "<string>",
"schema": {},
"prompt": "<string>"
},
"options": { "ocr": False }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"job_id": "<string>",
"status": "running",
"held_micro": 123
}{
"error": {
"code": "addendum_required",
"message": "<string>",
"next": "<string>",
"request_id": "<string>",
"retryable": true,
"effect": "none",
"slot": "<string>",
"required_micro": 123,
"reason": "balance",
"plan": "<string>",
"needs": [
{
"kind": "approval",
"detail": "<string>",
"step": "<string>"
}
]
}
}Authorizations
API key: sk_live_…
Headers
Optional. A retry with the same key returns the stored run.
Maximum string length:
255The plan a person approved, from the estimate. Required when a step of the plan needs approval. A request that makes a different plan (another input, option, step, price, organisation or member), or a plan more than 15 minutes old, is refused with conflict.
Body
application/json
Response
Run started; poll GET /v1/jobs/{id}