Skip to main content
GET
/
v0
/
quickstarts
List quickstarts
curl --request GET \
  --url https://api.avidoai.com/v0/quickstarts \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "title": "My Quickstart",
      "status": "MATERIALS_UPLOAD",
      "generateKbFromMaterials": false,
      "reuseTasksTopics": false,
      "description": "A quickstart for onboarding"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4,
    "totalCount": 100
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

​
skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991
Example:

0

​
limit
integer

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

​
orderBy
string
default:createdAt

Field to order by in the result set.

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
status
enum<string>

Filter by quickstart status

Available options:
MATERIALS_UPLOAD,
MATERIALS_PROCESSING,
MATERIALS_PROCESSING_FAILED,
TASKS_TOPICS_REVIEW,
KB_PROCESSING,
KB_PROCESSING_FAILED,
KB_REVIEW,
POLICIES_PROCESSING,
POLICIES_PROCESSING_FAILED,
POLICIES_REVIEW,
BASELINE_PROCESSING,
BASELINE_REVIEW,
COMPLETE
Example:

"MATERIALS_UPLOAD"

Response

Successfully retrieved quickstarts

Paginated response containing quickstarts

​
data
object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.