DeepResearch

Toggle public access for a task

Toggle the public visibility of a DeepResearch task. When set to true, the task results become accessible via a public share link without authentication. Only the task owner can modify the public flag.

post/v1/deepresearch/tasks/{id}/public

Request

Base URL: https://api.valyu.ai
URL: https://api.valyu.ai/v1/deepresearch/tasks/{id}/public
Auth: API key in header X-API-Key

Path parameters

idstring required

DeepResearch task ID.

Request body

publicboolean required

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

Example request

{
  "public": true
}

Response

Public flag updated.

successboolean required

Whether the operation succeeded.

messagestring required

Human-readable status message.

deepresearch_idstring required

ID of the affected task.

publicboolean required

The updated public visibility status.

Example response

{
  "success": true,
  "message": "Public flag updated",
  "deepresearch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "public": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.