Python
import os
from scale_gp import SGPClient
client = SGPClient(
api_key=os.environ.get("SGP_API_KEY"), # This is the default and can be omitted
)
question_set = client.question_sets.create(
account_id="account_id",
name="name",
question_ids=["string"],
)
print(question_set.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)
func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
questionSet, err := client.QuestionSets.New(context.TODO(), sgp.QuestionSetNewParams{
AccountID: sgp.F("account_id"),
Name: sgp.F("name"),
QuestionIDs: sgp.F([]string{"string"}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", questionSet.ID)
}
curl --request POST \
--url https://api.egp.scale.com/v4/question-sets \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_id": "<string>",
"question_ids": [
"<string>"
],
"question_id_to_config": {},
"instructions": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_id: '<string>',
question_ids: ['<string>'],
question_id_to_config: {},
instructions: '<string>'
})
};
fetch('https://api.egp.scale.com/v4/question-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/question-sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'account_id' => '<string>',
'question_ids' => [
'<string>'
],
'question_id_to_config' => [
],
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/question-sets")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"question_ids\": [\n \"<string>\"\n ],\n \"question_id_to_config\": {},\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/question-sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"question_ids\": [\n \"<string>\"\n ],\n \"question_id_to_config\": {},\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"question_id_to_config": {},
"instructions": "<string>",
"archived_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Question Sets
Create Question Set
Description
Creates a question set
Details
This API can be used to create a question set. To use this API, review the request schema and pass in all fields that are required to create a question set.
POST
/
v4
/
question-sets
Python
import os
from scale_gp import SGPClient
client = SGPClient(
api_key=os.environ.get("SGP_API_KEY"), # This is the default and can be omitted
)
question_set = client.question_sets.create(
account_id="account_id",
name="name",
question_ids=["string"],
)
print(question_set.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)
func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
questionSet, err := client.QuestionSets.New(context.TODO(), sgp.QuestionSetNewParams{
AccountID: sgp.F("account_id"),
Name: sgp.F("name"),
QuestionIDs: sgp.F([]string{"string"}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", questionSet.ID)
}
curl --request POST \
--url https://api.egp.scale.com/v4/question-sets \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_id": "<string>",
"question_ids": [
"<string>"
],
"question_id_to_config": {},
"instructions": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_id: '<string>',
question_ids: ['<string>'],
question_id_to_config: {},
instructions: '<string>'
})
};
fetch('https://api.egp.scale.com/v4/question-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/question-sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'account_id' => '<string>',
'question_ids' => [
'<string>'
],
'question_id_to_config' => [
],
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/question-sets")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"question_ids\": [\n \"<string>\"\n ],\n \"question_id_to_config\": {},\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/question-sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"question_ids\": [\n \"<string>\"\n ],\n \"question_id_to_config\": {},\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"question_id_to_config": {},
"instructions": "<string>",
"archived_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
The ID of the account that owns the given entity.
IDs of questions in the question set
Specifies additional configurations to use for specific questions in the context of the question set. For example, {<question_a_id>: {required: true}, <question_b_id>: {required: true}} sets two questions as required.
Show child attributes
Show child attributes
Instructions to answer questions
Response
Successful Response
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
The type of identity that created the entity.
Available options:
user, service_account Specifies additional configurations to use for specific questions in the context of the question set. For example, {<question_a_id>: {required: true}, <question_b_id>: {required: true}} sets two questions as required.
Show child attributes
Show child attributes
Instructions to answer questions
The date and time when the entity was archived in ISO format.