Skip to navigation

Create Task Share

Create a shareable link for a task.

Share links allow external users to:

  • View task details without authentication
  • Run tasks with pre-configured inputs
  • Access task results

Configure share settings:

  • title / description to override what’s shown on the public share page
  • expires_at — an absolute timestamp after which the share stops working (optional; omit for a share that never expires)
  • task_revision_id — share a specific revision instead of the task’s current active revision (optional)
  • task_run_id — attach an existing task run as a worked example on the share page; must belong to the revision being shared (optional)
  • custom_short_id — a 3-5 character custom short link identifier (optional; a random one is generated if omitted). Known issue: as of this writing, passing custom_short_id causes a 500 error on the server; omit it until this is fixed.

RAG-backed Task revisions are not currently shareable because their collections are project-local. MCP-backed Task revisions can be shared; clone copies or reuses MCP server and tool metadata without copying credentials.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.
task_idstringRequiredformat: "uuid"
The specific Task to reference.

Request

This endpoint expects an object.
titlestring or nullOptional
descriptionstring or nullOptional
expires_atdatetime or nullOptional
task_revision_idstring or nullOptionalformat: "uuid"
task_run_idstring or nullOptionalformat: "uuid"
Optional TaskRun ID to include as an example. Must belong to the task revision being shared.
custom_short_idstring or nullOptionalformat: "^[a-zA-Z0-9]+$"3-5 characters

Response

Share link created
idstringformat: "uuid"
task_idstringformat: "uuid"
task_revision_idstringformat: "uuid"
user_idstringformat: "uuid"
task_namestring
Name of the associated task
short_idstring
share_urlstring
views_countinteger
activeboolean
createdstring
modifiedstring
titlestring or nullOptional
descriptionstring or nullOptional
expires_atstring or nullOptional
task_run_idstring or nullOptionalformat: "uuid"
Optional TaskRun ID included as an example of the task's performance.
tagslist of objectsOptionalDefaults to []

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error