API docs by Redocly

Entanglement API (v0.34.19)

Download OpenAPI specification:Download

description here

Returns datasets matching a query

Returns datasets matching a query

Authorizations:
Auth0
query Parameters
ids
string
category
string
Enum: "dataset" "training-set" "model" "transform" "hyperparameters" "constants"
search
string
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

Add a dataset to entanglement

Add a dataset to entanglement

Authorizations:
Auth0
path Parameters
name
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

the object's unique name within the project

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Request Body schema: application/json

dataset to add

object (dataset)
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "dataset": {
    },
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "uid": "string"
}

Returns a dataset specification

Returns a dataset specification

Authorizations:
Auth0
path Parameters
dataset_id
required
string
query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

Validates a dataset

Validates a dataset

Authorizations:
Auth0
Request Body schema: application/json

A dataset to validate

body
string

base64 encoded yaml, json, or cue string of the dataset description

format
string
Enum: "json" "yaml" "cue"
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "format": "json",
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "body": "string"
}

Returns modelsets matching a query

Returns modelsets matching a query

Authorizations:
Auth0
query Parameters
ids
string
category
string
Enum: "dataset" "training-set" "model" "transform" "hyperparameters" "constants"
search
string
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

Add a Modelset to entanglement

Add a Modelset to entanglement

Authorizations:
Auth0
path Parameters
name
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

the object's unique name within the project

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Request Body schema: application/json

Modelset to add

object (dataset)
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "modelset": {
    },
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "status": 403,
  • "type": "Forbidden",
  • "title": "Not Authorized",
  • "detail": "You must provide token to access this API",
  • "instance": null
}

Returns a modelset specification

Returns a modelset specification

Authorizations:
Auth0
path Parameters
modelset_id
required
string
query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

Validates a modelset

Validates a modelset

Authorizations:
Auth0
Request Body schema: application/json

A dataset to validate

body
string

base64 encoded yaml, json, or cue string of the dataset description

format
string
Enum: "json" "yaml" "cue"
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "format": "json",
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "body": "string"
}

Get all predicates currently registered with Entan

Get all predicates currently registered with Entanglement

Authorizations:
Auth0

Responses

Response samples

Content type
application/json
{
  • "predicates": [
    ]
}

Add predicates to a corresponing type. Overwrites

Add predicates to a corresponing type. Overwrites the type definition, so if you want to add to an existing type, ensure those predicates are included in the list.

Authorizations:
Auth0
Request Body schema: application/json

add specified predicates to entanglement

type
string^[A-Z]+[a-zA-Z]*$
Array of objects

Responses

Request samples

Content type
application/json
{
  • "type": "MyType",
  • "predicates": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Get all predicates per class. This gives you an id

Get all predicates per class. This gives you an idea of what options are out there for adding connections, and which Types may need to be added to the predicate ontology.

Authorizations:
Auth0

Responses

Response samples

Content type
application/json
{
  • "types": [
    ]
}

Get incoming and outgoing edges for an object

Get incoming and outgoing edges for an object

Authorizations:
Auth0
path Parameters
uid
required
string (uid) ^0x[0-9a-fA-F]+$

the object's uid, which is unique across the entire graph

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

predicates
string
Example: predicates=can-observe

select which predicates to return, comma separated predicate names

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a connection between this and another object

Add a connection between this and another object

Authorizations:
Auth0
Request Body schema: application/json

An object of connections to add

Array of objects
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "connections": [
    ],
  • "project": "global"
}

Response samples

Content type
application/json
{ }

Remove a connection between this and another objec

Remove a connection between this and another object

Authorizations:
Auth0
Request Body schema: application/json

An object of connections to remove

Array of objects
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "connections": [
    ],
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "success": true
}

Return all objects in a project matching given fil

Return all objects in a project matching given filters

Authorizations:
Auth0
query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Add one or more objects

Add one or more objects

Authorizations:
Auth0
Request Body schema: application/json

An array of objects to add

Array of objects (object)
project
string (project) ^(\w+[\w\-\_]*|\*)$

The project for an object/connection

Responses

Request samples

Content type
application/json
{
  • "objects": [
    ],
  • "project": "global"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "uids": [
    ]
}

Delete one or more objects

Delete one or more objects

Authorizations:
Auth0
query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

uids
required
string
Example: uids=0x0234,0x1234,0x7865

a comma separated list of UIDs to delete

hard
boolean
Default: false

remove object entirely from version control (unreversable)

Responses

Response samples

Content type
application/json
{
  • "requested": 0,
  • "deleted": 0
}

Return object of specified uid

Return object of specified uid

Authorizations:
Auth0
path Parameters
uid
required
string (uid) ^0x[0-9a-fA-F]+$

the object's uid, which is unique across the entire graph

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Lists all objects of given class

Lists all objects of given class

Authorizations:
Auth0
path Parameters
class
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

object class to query on

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Lists all objects of given class and domain

Lists all objects of given class and domain

Authorizations:
Auth0
path Parameters
class
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

object class to query on

domain
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

domain the objects belong to

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Lists all objects of given class, domain, and cate

Lists all objects of given class, domain, and category

Authorizations:
Auth0
path Parameters
class
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

object class to query on

domain
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

domain the objects belong to

category
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

category under domain the objects belong to

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Lists all objects of given class, domain, and cate

Lists all objects of given class, domain, and category

Authorizations:
Auth0
path Parameters
class
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

object class to query on

domain
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

domain the objects belong to

category
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

category under domain the objects belong to

type
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

type under category and domain the objects belong to

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

page
integer

The page number for large result lists

page_size
integer

The number of results to get at once

xid
string

query by exact match on an external ID (xid)

search
string

a free text search string that will search indexed fields: name, description, alias

spatial
string
Example: spatial={ "geometry": { "type": "Polygon", "coordinates": [...] }, "predicate": "intersects" }

Spatial query, json encoded

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}

Lists all objects of given class, domain, and cate

Lists all objects of given class, domain, and category

Authorizations:
Auth0
path Parameters
class
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

object class to query on

domain
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

domain the objects belong to

category
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

category under domain the objects belong to

type
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

type under category and domain the objects belong to

name
required
string (qualifier) ^[a-z]+[a-z\-\_]*$

the object's unique name within the project

query Parameters
project
string (project) ^(\w+[\w\-\_]*|\*)$
Example: project=global

The project for an object/connection

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ]
}