Link item

POST

/api/v1/org/{org}/ws/{workspace}/projects/{project}/items/{item_id}/links

curl --request POST \
  --url https://example.com/api/v1/org/example/ws/example/projects/example/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "relationship": "example", "target_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "target_ref": "example" }'

Create a directed link from this item to another (same project).

Authorizations

• OAuth2PasswordBearer
• APIKeyCookie
• APIKeyHeader

Parameters

Path Parameters

item_id

required

Item Id

string format: uuid

project

required

Project

Project slug or UUID

string

Project slug or UUID

workspace

required

Workspace

Workspace slug

string

Workspace slug

org

required

Org

Organization slug

string

Organization slug

Request Body ^required

Media type application/json

CreateItemLinkRequest

Create a directed link from the path item to a target.

The target is addressed by target_item_id (UUID) or target_ref (the agent-assigned ref) — exactly one. Refs let agents link without juggling UUIDs.

object

relationship

required

Relationship

string

>= 1 characters <= 64 characters

target_item_id

Any of:

string

string format: uuid

null

null

target_ref

Any of:

string

string

<= 128 characters

null

null

Example ^generated

{
  "relationship": "example",
  "target_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "target_ref": "example"
}

Responses

201

Successful Response

Media type application/json

ItemLinkResponse

object

created_at

required

Created At

string format: date-time

id

required

Id

string format: uuid

project_id

required

Project Id

string format: uuid

relationship

required

Relationship

string

source_item_id

required

Source Item Id

string format: uuid

target_item_id

required

Target Item Id

string format: uuid

Example ^generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "relationship": "example",
  "source_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "target_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Invalid request

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

401

Authentication failed

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

403

Access forbidden

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

404

Not found

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

409

Already exists

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

422

Validation error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

426

Upgrade required

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

429

Rate limited

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

500

Internal server error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

502

Bad gateway

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

504

Gateway timeout

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}