Skip to main content
POST
Add or remove the people (name@company.com) and company domains (@company.com) who can open a report. The report stays private: viewers sign in to Valyu with an email it is shared with. Additions and removals apply together or not at all. Each person you add is emailed a link unless you send "notify": false. Domains are never emailed. Only the API key that created the task can change its sharing. See share a report with specific people for the rules.

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

People or company domains to add to or remove from a report. At least one of add or remove must name someone. Additions and removals apply together or not at all.

​
add
string[]

Email addresses (name@company.com) or company domains (@company.com) to share the report with. Public email providers can't be added as a domain.

Example:
​
remove
string[]

Email addresses or company domains to stop sharing the report with, in the same format as add.

Example:
​
notify
boolean
default:true

Email each person in add a link to the report. Domains are never emailed.

​
shared_by
string

How the email names the sender. Defaults to your organization's name.

Maximum string length: 80
Example:

"Maya at Northwind Capital"

Response

Sharing updated.

Who a DeepResearch report is shared with after the change.

​
deepresearch_id
string
required

ID of the task.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
public
boolean
required

Whether anyone with the link can open the report. Set with Toggle public access. Independent of shared_with.

Example:

false

​
share_url
string<uri>
required

Link to the report.

Example:

"https://platform.valyu.ai/share/a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
shared_with
object[]
required

People and domains the report is shared with.

​
notified
string<email>[]
required

Email addresses that were sent a link in this request.

Example: