Skip to main content
POST
/
api
/
v1
/
sinks
Create Sink
curl --request POST \
  --url http://localhost:3301/api/v1/sinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "neutral",
  "is_public": true,
  "public_slug": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "color": "neutral",
  "is_public": true,
  "public_slug": "<string>",
  "secret": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
name
string
required

Sink name

Required string length: 1 - 255
description
string | null

Optional description

color
enum<string>

Display color

Available options:
neutral,
blue,
green,
yellow,
orange,
red,
purple,
pink
is_public
boolean

Whether the sink is publicly accessible

public_slug
string | null

Public URL slug

Required string length: 1 - 255

Response

A sink collects and organizes items from external sources

A sink collects and organizes items from external sources

id
string<uuid>

Unique identifier

name
string

Sink name

Required string length: 1 - 255
description
string | null

Optional description

color
enum<string>

Display color

Available options:
neutral,
blue,
green,
yellow,
orange,
red,
purple,
pink
is_public
boolean

Whether the sink is publicly accessible

public_slug
string | null

Public URL slug

Required string length: 1 - 255
secret
string

Secret key for adding items to this sink

workspace_id
string<uuid>

Workspace ID

owner_id
string<uuid>

Owner user ID

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp