Create TaskAgent Share

POST

/org/:org_id/project/:project_id/task-agent/:task_agent_id/share

POST

/api/v1/org/:org_id/project/:project_id/task-agent/:task_agent_id/share

$ curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/task-agent/task_agent_id/share \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Support Agent",
>   "description": "Handles support triage and draft responses.",
>   "task_agent_revision_id": "019df849-e12a-b57e-62d4-0e5875e91ef4",
>   "custom_short_id": "supportagent"
> }'

1 {
2   "id": "019a58ec-43b5-a1e5-60a8-c9653e6badbe",
3   "project_id": "0190a234-9876-5432-10ab-cdef01234567",
4   "task_agent_id": "019df849-e106-3301-5894-291b4c9c6cab",
5   "task_agent_revision_id": "019df849-e12a-b57e-62d4-0e5875e91ef4",
6   "user_id": "0190c234-1111-2222-3333-444444444444",
7   "task_agent_name": "Support Agent",
8   "short_id": "supportagent",
9   "views_count": 12,
10   "active": true,
11   "created": "2026-05-05T10:15:00Z",
12   "share_url": "https://app.rightbrain.ai/api/v1/public/task_agent_share/supportagent",
13   "title": "Support Agent",
14   "description": "Handles support triage and draft responses.",
15   "modified": "2026-05-05T10:15:00Z",
16   "tags": []
17 }

Create a public share link for a TaskAgent revision.

Requires task_agent:edit on the parent TaskAgent. If task_agent_revision_id is omitted, the active revision is shared. Custom short IDs must be unique and match the schema constraints; generated short IDs use high-entropy random characters.

TaskAgent shares cannot include Task-tool revisions backed by RAG collections, including disabled Task-tool attachments, because those collections are project-local and are not cloned. TaskAgent shares also cannot include deleted Task-tool dependencies.

Create a public share link for a TaskAgent revision. Requires `task_agent:edit` on the parent TaskAgent. If `task_agent_revision_id` is omitted, the active revision is shared. Custom short IDs must be unique and match the schema constraints; generated short IDs use high-entropy random characters. TaskAgent shares cannot include Task-tool revisions backed by RAG collections, including disabled Task-tool attachments, because those collections are project-local and are not cloned. TaskAgent shares also cannot include deleted Task-tool dependencies.

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.

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 organization ID

project_idstringRequiredformat: "uuid"

The project ID

task_agent_idstringRequiredformat: "uuid"

The task agent ID

Request

This endpoint expects an object.

titlestring or nullOptional<=255 characters

descriptionstring or nullOptional<=1000 characters

expires_atdatetime or nullOptional

task_agent_revision_idstring or nullOptionalformat: "uuid"

Optional pinned TaskAgent revision. Defaults to the active revision.

custom_short_idstring or nullOptionalformat: "^[a-zA-Z0-9_-]+$"3-64 characters

Optional custom public short ID.

Response

TaskAgent share created

idstringformat: "uuid"

project_idstringformat: "uuid"

task_agent_idstringformat: "uuid"

task_agent_revision_idstringformat: "uuid"

user_idstringformat: "uuid"

task_agent_namestring

short_idstring

views_countinteger

activeboolean

createdstring

share_urlstringRead-only

titlestring or nullOptional<=255 characters

descriptionstring or nullOptional<=1000 characters

expires_atstring or nullOptional

modifiedstring or nullOptional

tagslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error