Logo
Search
Docs

Library assignments

GET https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/assignments

List every assignment for documents in a library, across all assistants

Authentication

Send a bearer token created on your dashboard's Developer page:

Authorization: Bearer <YOUR_API_KEY>

Path parameters

knowledge_base string Required

The library.

Validation: the library's UUID
Stored in knowledge_bases.id

Errors

StatusMeaningBody
404 Library not found {"message":"No query results for model [App\\Models\\KnowledgeBase] <id>."}
403 Policy denied — outside your organization, or you cannot write to this resource {"message":"This action is unauthorized."}
401 Missing or invalid bearer token
403 Feature knowledge_docs not enabled for the account

Notes

  • Each row's nested assistant object carries vapi_assistant_id verbatim (the assistant's public identifier) alongside its internal numeric id.
curl --request GET \
  --url https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/assignments \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
import requests

url = "https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/assignments"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
print(response.json())
package main

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

func main() {
	url := "https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/assignments"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
Response 200
{
    "data": [
        {
            "id": "d4e5f6a7-b8c9-0123-defa-456789012345",
            "reseller_id": "f1e2d3c4-b5a6-4978-8901-234567890abc",
            "assistant_id": 12,
            "knowledge_article_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
            "created_at": "2026-07-30T14:50:00.000000Z",
            "updated_at": "2026-07-30T14:50:00.000000Z",
            "assistant": {
                "id": 12,
                "name": "Front Desk",
                "vapi_assistant_id": "e5f6a7b8-c9d0-1234-efab-567890123456",
                "phone_number": "+14155551234"
            },
            "knowledge_article": {
                "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                "title": "Return Policy",
                "status": "published",
                "knowledge_base_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
            }
        }
    ]
}