Labelling
Create labeling job
Ask teacher models to label a query source for review.
POST
/
v1
/
labeling
/
jobs
Create labeling job
curl --request POST \
--url https://api.sqwish.ai/v1/labeling/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "<string>",
"name": "<string>",
"decisions": [
{
"id": "<string>",
"question": "<string>",
"kind": "single",
"outcomes": "<unknown>",
"rubric": [
"<unknown>"
],
"policy": {
"action_costs": {},
"abstain_below": 0.5
}
}
],
"teacher_models": [],
"max_price_usd": "<string>"
}
'import requests
url = "https://api.sqwish.ai/v1/labeling/jobs"
payload = {
"source_id": "<string>",
"name": "<string>",
"decisions": [
{
"id": "<string>",
"question": "<string>",
"kind": "single",
"outcomes": "<unknown>",
"rubric": ["<unknown>"],
"policy": {
"action_costs": {},
"abstain_below": 0.5
}
}
],
"teacher_models": [],
"max_price_usd": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source_id: '<string>',
name: '<string>',
decisions: [
{
id: '<string>',
question: '<string>',
kind: 'single',
outcomes: '<unknown>',
rubric: ['<unknown>'],
policy: {action_costs: {}, abstain_below: 0.5}
}
],
teacher_models: [],
max_price_usd: '<string>'
})
};
fetch('https://api.sqwish.ai/v1/labeling/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"name": "<string>",
"source_id": "<string>",
"status": "queued",
"teacher_models": [
"<string>"
],
"rows": 123,
"completed_rows": 123,
"valid_rows": 123,
"agreement_rows": 123,
"error_rows": 123,
"created_at": 123,
"updated_at": 123,
"price_usd": "<string>",
"charge": "free",
"dataset_id": "<string>",
"error": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}Authorizations
Create an API key in the console.
Headers
Body
application/json
Pattern:
^src_[a-f0-9]{24}$Required string length:
1 - 120Required array length:
1 - 64 elementsShow child attributes
Show child attributes
Required array length:
1 - 2 elementsAvailable options:
kimi-k3, glm-5.3 The most you agree to pay for this job, in USD, such as the price you were shown. It is a decimal string, such as "2.500000000", never a JSON number, so no precision is lost: a number is refused with invalid_request, naming this field. If it costs more when it is admitted, it is refused with price_changed and nothing is held.
Pattern:
^\d{1,9}(\.\d{1,9})?$Response
Successful Response
deleted: you deleted its source, and with it the queries and the teachers' answers. The job and its counts stay.
Available options:
queued, running, cancelling, cancelled, review_ready, failed, finalized, discarded, deleted The job's fee, as exact USD: each of its teachers' price for a row, for every row.
What the fee is doing: held while the job runs, charged once its labels are ready for review, released if it fails or is cancelled first.
Available options:
free, reserved, charged, released Create labeling job
curl --request POST \
--url https://api.sqwish.ai/v1/labeling/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "<string>",
"name": "<string>",
"decisions": [
{
"id": "<string>",
"question": "<string>",
"kind": "single",
"outcomes": "<unknown>",
"rubric": [
"<unknown>"
],
"policy": {
"action_costs": {},
"abstain_below": 0.5
}
}
],
"teacher_models": [],
"max_price_usd": "<string>"
}
'import requests
url = "https://api.sqwish.ai/v1/labeling/jobs"
payload = {
"source_id": "<string>",
"name": "<string>",
"decisions": [
{
"id": "<string>",
"question": "<string>",
"kind": "single",
"outcomes": "<unknown>",
"rubric": ["<unknown>"],
"policy": {
"action_costs": {},
"abstain_below": 0.5
}
}
],
"teacher_models": [],
"max_price_usd": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source_id: '<string>',
name: '<string>',
decisions: [
{
id: '<string>',
question: '<string>',
kind: 'single',
outcomes: '<unknown>',
rubric: ['<unknown>'],
policy: {action_costs: {}, abstain_below: 0.5}
}
],
teacher_models: [],
max_price_usd: '<string>'
})
};
fetch('https://api.sqwish.ai/v1/labeling/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"name": "<string>",
"source_id": "<string>",
"status": "queued",
"teacher_models": [
"<string>"
],
"rows": 123,
"completed_rows": 123,
"valid_rows": 123,
"agreement_rows": 123,
"error_rows": 123,
"created_at": 123,
"updated_at": 123,
"price_usd": "<string>",
"charge": "free",
"dataset_id": "<string>",
"error": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}