Question set

curl --request POST \
  --url https://api.sigmora.org/v1/text/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "text": "A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.",
  "type": "multiple-choice",
  "numberOfQuestions": 5,
  "difficulty": "easy",
  "subject": "statistics"
}
'

import requests

url = "https://api.sigmora.org/v1/text/questions"

payload = {
    "projectId": "prj_9x2a4c",
    "text": "A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.",
    "type": "multiple-choice",
    "numberOfQuestions": 5,
    "difficulty": "easy",
    "subject": "statistics"
}
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({
    projectId: 'prj_9x2a4c',
    text: 'A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.',
    type: 'multiple-choice',
    numberOfQuestions: 5,
    difficulty: 'easy',
    subject: 'statistics'
  })
};

fetch('https://api.sigmora.org/v1/text/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "credits": 300,
  "questions": {
    "result": "<string>",
    "platform": "<string>",
    "domain": "<string>"
  },
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

POST

text

questions

Question set

curl --request POST \
  --url https://api.sigmora.org/v1/text/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "text": "A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.",
  "type": "multiple-choice",
  "numberOfQuestions": 5,
  "difficulty": "easy",
  "subject": "statistics"
}
'

import requests

url = "https://api.sigmora.org/v1/text/questions"

payload = {
    "projectId": "prj_9x2a4c",
    "text": "A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.",
    "type": "multiple-choice",
    "numberOfQuestions": 5,
    "difficulty": "easy",
    "subject": "statistics"
}
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({
    projectId: 'prj_9x2a4c',
    text: 'A mean tells you where the middle of your data sits; a standard deviation tells you how far a typical point wanders from it. Two classes can share a mean of 70 and still look nothing alike: in one, every score lands between 65 and 75; in the other, half the room scored 40 and half scored 100. The standard deviation is the number that tells those classes apart.',
    type: 'multiple-choice',
    numberOfQuestions: 5,
    difficulty: 'easy',
    subject: 'statistics'
  })
};

fetch('https://api.sigmora.org/v1/text/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "credits": 300,
  "questions": {
    "result": "<string>",
    "platform": "<string>",
    "domain": "<string>"
  },
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255

x-sigmora-quote-only

string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"

x-sigmora-max-credits

string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json

text

string

required

The source material to write questions from.

Required string length: 1 - 50000

type

string

required

Question format, e.g. multiple-choice, short-answer, true-false.

Required string length: 1 - 60

numberOfQuestions

integer

required

How many to produce, 1–20.

Required range: 1 <= x <= 20

projectId

string

required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

difficulty

string

e.g. easy, exam, olympiad.

Maximum string length: 60

subject

string

The subject, for correct terminology.

Maximum string length: 200

gradeLevel

string

Who is sitting it, e.g. undergraduate.

Maximum string length: 50

Response

Success.

Option 1
Option 2

success

boolean

required

credits

number

required

What this call actually cost, which is not always what was quoted.

Example:

300

questions

object

required

The question set, with answers where the format has them. The text is under result.

Show child attributes

projectId

string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance

number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Question set

Authorizations

Headers

Body

Response