Sessions
Session projection
Public audience view by default. ?host=1 or ?mode=wall need host auth
(k, cookie, or Bearer). Host payload includes k, roster, and quiz keys
on polls[]. Wall is tallies + approved Qs, no roster.
GET
/
api
/
sessions
/
{id}
Session projection
curl --request GET \
--url https://www.askplane.com/api/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.askplane.com/api/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.askplane.com/api/sessions/{id}', 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://www.askplane.com/api/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.askplane.com/api/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.askplane.com/api/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.askplane.com/api/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "live",
"code": "<string>",
"title": "<string>",
"brand": {},
"poll": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "multiple_choice",
"prompt": "<string>",
"state": "draft",
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"tally": 123
}
],
"correctOptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"words": [
{
"text": "<string>",
"n": 123
}
],
"texts": [
"<string>"
],
"votes": 123
},
"polls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "multiple_choice",
"prompt": "<string>",
"state": "draft",
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"tally": 123
}
],
"correctOptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"words": [
{
"text": "<string>",
"n": 123
}
],
"texts": [
"<string>"
],
"votes": 123
}
],
"questions": [
{}
],
"highlightedQuestionId": "<string>",
"voted": true,
"voteOptionId": "<string>",
"k": "<string>",
"participantCount": 123,
"createdAt": 123,
"endsAt": 123,
"roster": [
{
"email": "<string>",
"name": "<string>",
"vote": "<string>",
"questions": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Host projection. Requires host auth.
Available options:
1 Projector wall. Requires host auth.
Available options:
wall Per-room host key.
Response
Projection. Shape depends on audience / host / wall.
Available options:
live, ended Show child attributes
Show child attributes
Show child attributes
Show child attributes
Host only.
Host only. Do not send to an LLM tool.
Show child attributes
Show child attributes
⌘I
Session projection
curl --request GET \
--url https://www.askplane.com/api/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.askplane.com/api/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.askplane.com/api/sessions/{id}', 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://www.askplane.com/api/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.askplane.com/api/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.askplane.com/api/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.askplane.com/api/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "live",
"code": "<string>",
"title": "<string>",
"brand": {},
"poll": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "multiple_choice",
"prompt": "<string>",
"state": "draft",
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"tally": 123
}
],
"correctOptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"words": [
{
"text": "<string>",
"n": 123
}
],
"texts": [
"<string>"
],
"votes": 123
},
"polls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "multiple_choice",
"prompt": "<string>",
"state": "draft",
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"tally": 123
}
],
"correctOptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"words": [
{
"text": "<string>",
"n": 123
}
],
"texts": [
"<string>"
],
"votes": 123
}
],
"questions": [
{}
],
"highlightedQuestionId": "<string>",
"voted": true,
"voteOptionId": "<string>",
"k": "<string>",
"participantCount": 123,
"createdAt": 123,
"endsAt": 123,
"roster": [
{
"email": "<string>",
"name": "<string>",
"vote": "<string>",
"questions": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}