Skip to main content
PUT
/
agent-sessions
/
{session_id}
/
documents
/
{document_id}
/
star
Star/Unstar document
import requests

url = "https://app.ubik-agent.com/api/v1/agent-sessions/{session_id}/documents/{document_id}/star"

payload = { "is_starred": True }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Headers

X-End-User-ID
string | null

Path Parameters

session_id
string<uuid>
required
document_id
string<uuid>
required

Body

application/json
is_starred
boolean
required

Whether the document should be starred (true) or unstarred (false).

Response

Successful Response