Query Studio's starter queries, and whether to offer them

GET

/api/v1/kg/studio/examples

const url = 'http://localhost:11044/api/v1/kg/studio/examples';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/kg/studio/examples \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

The examples this world ships — default-world’s, the world’s own and each installed realm’s — and whether to show them over an empty editor. show is false once the person has dismissed them, saved a view of their own, or written threshold distinct queries of their own in Query Studio; hiddenBecause says which. Every example is returned either way, for a client that shows them on request.

Authorizations

apiKeyAuth
basicAuth

Responses

200

The examples and the verdict on offering them

application/json

Query Studio’s starter queries, and whether to offer them to the signed-in person

object

examples

required

Every example this world offers, in the order its files declare them: default-world’s, the world’s own, then each installed realm’s

Array<object>

One starter query

object

cypher

required

The query, to put in the editor and run exactly as written

string

description

required

One line: what running it demonstrates

string

required

Unique within this world: the file it came from, then the id the file gave it

string

kind

required

ai when the query asks a model to read, judge or label as it runs, so running it costs model calls; plain for Cypher over what the world holds

string

Allowed values: ai plain

source

The realm that shipped it; absent for default-world’s and the world’s own

string

title

required

The card’s heading

string

hiddenBecause

Why they are not offered: DISMISSED, SAVED_VIEW (the person has saved a view of their own) or EXPERIENCED (they have written threshold queries of their own in Query Studio); absent while they are offered

string

Allowed values: DISMISSED SAVED_VIEW EXPERIENCED

show

required

Whether to show the examples over an empty editor without being asked

boolean

studioQueries

required

Distinct queries of their own the person has written in Query Studio, as far as the query log still holds; 0 when the verdict did not need counting

integer format: int32

threshold

required

How many distinct queries of their own retire the examples

integer format: int32

Example

{
  "examples": [
    {
      "kind": "ai"
    }
  ],
  "hiddenBecause": "DISMISSED"
}

401

Not authenticated