Skip to main content
POST
/
api
/
workspaces
/
{id}
/
relationships
Add a relationship
curl --request POST \
  --url https://archyon.app/api/workspaces/{id}/relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "sourceId": "<string>",
  "targetId": "<string>",
  "typeId": "<string>",
  "label": "<string>",
  "properties": {}
}
'
{
  "relationship": {
    "id": "<string>",
    "workspaceId": "<string>",
    "sourceId": "<string>",
    "targetId": "<string>",
    "typeId": "<string>",
    "properties": {},
    "label": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.archyon.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Both Clerk session JWTs (browser) and Archyon Personal Access Tokens (an_pat_…, server / CLI / MCP) use the same Bearer header. The server distinguishes them by token shape.

  • Clerk JWTs carry org context in the token claims (org_id, org_role, org_slug) — required for org-scoped endpoints. Configure your Clerk session template to include these claims; see DEPLOYMENT.md.
  • PATs are minted at /account → Tokens. Each PAT is bound to whichever org was active at mint time. Switch orgs and re-mint to address a different org.

Path Parameters

id
string
required

Workspace id (slug-like; provided at create time).

Body

application/json
id
string
required
sourceId
string
required
targetId
string
required
typeId
string
required
label
string
properties
object

Response

Created.

relationship
object
required