Skip to main content
POST
Change whether a task can be accessed through a public share link. When public access is enabled, the share link does not require authentication. Keep reports private unless the user deliberately chooses to share them. Review the report and supporting material before enabling public access, particularly when a task includes uploaded files or private context. To share a report with specific people instead, and keep it private for everyone else, see share a report with specific people.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at platform.valyu.ai.

Path Parameters

id
string
required

DeepResearch task ID.

Body

application/json

Request to toggle the public visibility of a DeepResearch task.

public
boolean
required

Set to true to make the task publicly accessible, or false to make it private.

Example:

true

Response

Public flag updated.

success
boolean
required

Whether the operation succeeded.

Example:

true

message
string
required

Human-readable status message.

Example:

"Public flag updated"

deepresearch_id
string
required

ID of the affected task.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

public
boolean
required

The updated public visibility status.

Example:

true