Skip to main content
POST
/
api
/
playground
/
sessions
/
{session_id}
/
embedding
Compute Embedding
curl --request POST \
  --url https://api.example.com/api/playground/sessions/{session_id}/embedding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feature_columns": [
    "<string>"
  ],
  "method": "umap",
  "dimensions": 3,
  "label_column": "<string>",
  "n_neighbors": 15,
  "min_dist": 0.1,
  "perplexity": 30,
  "sample_size": 10000
}
'
{
  "session_id": "<string>",
  "method": "<string>",
  "dimensions": 123,
  "point_count": 123,
  "points": [
    {
      "index": 123,
      "x": 123,
      "y": 123,
      "cluster": 123,
      "z": 123,
      "label": "<string>"
    }
  ],
  "clusters": [
    {
      "id": 123,
      "size": 123,
      "centroid": [
        123
      ],
      "description": "",
      "top_labels": [],
      "top_features": []
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

session_id
string
required

Cookies

antidote_session
string | null

Body

application/json
feature_columns
string[]
required
Minimum array length: 1
method
enum<string>
default:umap
Available options:
pca,
tsne,
umap
dimensions
enum<integer>
default:3
Available options:
2,
3
label_column
string | null
n_neighbors
integer
default:15
Required range: 2 <= x <= 100
min_dist
number
default:0.1
Required range: 0 <= x <= 1
perplexity
integer
default:30
Required range: 5 <= x <= 100
sample_size
integer | null
default:10000
Required range: 100 <= x <= 100000

Response

Successful Response

session_id
string
required
method
string
required
dimensions
integer
required
point_count
integer
required
points
EmbeddingPoint · object[]
required
clusters
ClusterInfo · object[]
required