Skip to main content
POST
/
v1
/
submissions
Create a submission
curl --request POST \
  --url https://api.example.com/v1/submissions \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignment_id": "<string>",
  "student_id": "<string>",
  "content": {},
  "files": [
    null
  ]
}
'
import requests

url = "https://api.example.com/v1/submissions"

payload = {
"assignment_id": "<string>",
"student_id": "<string>",
"content": {},
"files": [None]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({assignment_id: '<string>', student_id: '<string>', content: {}, files: [null]})
};

fetch('https://api.example.com/v1/submissions', 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.example.com/v1/submissions",
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([
'assignment_id' => '<string>',
'student_id' => '<string>',
'content' => [

],
'files' => [
null
]
]),
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;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/submissions"

payload := strings.NewReader("{\n \"assignment_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"content\": {},\n \"files\": [\n null\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/submissions")
.header("Content-Type", "application/json")
.body("{\n \"assignment_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"content\": {},\n \"files\": [\n null\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/submissions")

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 \"assignment_id\": \"<string>\",\n \"student_id\": \"<string>\",\n \"content\": {},\n \"files\": [\n null\n ]\n}"

response = http.request(request)
puts response.read_body

Body

assignment_id
string
required
student_id
string
required
files
File[]
Up to 10 files. Pass as multipart upload or pre-uploaded file_ids.

Examples

await hk.submissions.create({
  assignment_id: "asg_123",
  student_id: "usr_42",
  content: { text: "Lorentz invariance means..." },
});
$hk->submissions->create([
    'assignment_id' => 'asg_123',
    'student_id' => 'usr_42',
    'content' => ['text' => 'Lorentz invariance means...'],
]);
With a file:
await hk.submissions.create({
  assignment_id: "asg_123",
  student_id: "usr_42",
  content: { text: "" },
  files: [{ name: "essay.pdf", body: blob, content_type: "application/pdf" }],
});
$hk->submissions->create([
    'assignment_id' => 'asg_123',
    'student_id' => 'usr_42',
    'content' => ['text' => ''],
    'files' => [[
        'name' => 'essay.pdf',
        'body' => fopen('/path/to/essay.pdf', 'r'),
        'content_type' => 'application/pdf',
    ]],
]);

Returns

A Submission in ai_status: "pending".