Skip to main content
GET
/
v0
/
quickstarts
/
{id}
/
topics
/
{topicId}
/
generated-articles
List generated articles for a quickstart topic
curl --request GET \
  --url https://api.avidoai.com/v0/quickstarts/{id}/topics/{topicId}/generated-articles \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "documentId": "doc_abc123",
      "documentTitle": "How to reset your password",
      "taskId": "task_xyz456",
      "taskTitle": "Password reset",
      "generationStage": "reviewed"
    }
  ]
}

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:

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

topicId
string<uuid>
required

The topic 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:

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

Response

Successfully retrieved generated articles

List of generated KB article summaries for a topic

data
GeneratedArticleSummary · object[]
required