Skip to main content
POST
/
v0
/
quickstarts
/
{id}
/
assignments
Create a new assignment
curl --request POST \
  --url https://api.avidoai.com/v0/quickstarts/{id}/assignments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "stage": "KB_REVIEW",
  "assignedTo": "user_789012",
  "topicId": "789e4567-e89b-12d3-a456-426614174000"
}
'
import requests

url = "https://api.avidoai.com/v0/quickstarts/{id}/assignments"

payload = {
"stage": "KB_REVIEW",
"assignedTo": "user_789012",
"topicId": "789e4567-e89b-12d3-a456-426614174000"
}
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
stage: 'KB_REVIEW',
assignedTo: 'user_789012',
topicId: '789e4567-e89b-12d3-a456-426614174000'
})
};

fetch('https://api.avidoai.com/v0/quickstarts/{id}/assignments', 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.avidoai.com/v0/quickstarts/{id}/assignments",
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([
'stage' => 'KB_REVIEW',
'assignedTo' => 'user_789012',
'topicId' => '789e4567-e89b-12d3-a456-426614174000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);

$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.avidoai.com/v0/quickstarts/{id}/assignments"

payload := strings.NewReader("{\n \"stage\": \"KB_REVIEW\",\n \"assignedTo\": \"user_789012\",\n \"topicId\": \"789e4567-e89b-12d3-a456-426614174000\"\n}")

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

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
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.avidoai.com/v0/quickstarts/{id}/assignments")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"stage\": \"KB_REVIEW\",\n \"assignedTo\": \"user_789012\",\n \"topicId\": \"789e4567-e89b-12d3-a456-426614174000\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.avidoai.com/v0/quickstarts/{id}/assignments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stage\": \"KB_REVIEW\",\n \"assignedTo\": \"user_789012\",\n \"topicId\": \"789e4567-e89b-12d3-a456-426614174000\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "quickstartId": "234e4567-e89b-12d3-a456-426614174000",
    "stage": "KB_REVIEW",
    "assignedTo": "user_789012",
    "topicId": "789e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    }
  }
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}
{
"message": "Resource not found"
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

id
string<uuid>
required

The quickstart ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"234e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for creating a new assignment

stage
enum<string>
required

The review stage this assignment belongs to

Available options:
KB_REVIEW,
TASKS_TOPICS_REVIEW,
POLICIES_REVIEW
Example:

"KB_REVIEW"

assignedTo
string
required

User ID to assign to

Required string length: 1 - 255
Example:

"user_789012"

topicId
string<uuid>
required

Topic ID to assign

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

Response

Successfully created assignment

Successful response containing the assignment data

data
AssignmentQuickstart · object
required

An assignment linking a user to a topic for a review stage