Skip to main content
POST
/
v1
/
quickstarts
Create a quickstart
curl --request POST \
  --url https://api.avidoai.com/v1/quickstarts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "My Quickstart",
  "description": "A quickstart for onboarding"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "title": "My Quickstart",
    "description": "A quickstart for onboarding",
    "status": "UPLOAD_MATERIALS"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new quickstart

​
title
string
required

The title of the quickstart

Required string length: 1 - 255
Example:

"My Quickstart"

​
description
string
required

The description of the quickstart

Required string length: 1 - 2048
Example:

"A quickstart for onboarding"

Response

Successfully created quickstart

Response containing a single quickstart

​
data
object
required