Compile bounded release-consistent ontology context

curl --request POST \
  --url https://api.atlan.com/ontology/v1/context-queries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ontology_id": "<string>",
  "query": "<string>",
  "release_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ontology_id: '<string>', query: '<string>', release_id: '<string>'})
};

fetch('https://api.atlan.com/ontology/v1/context-queries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.atlan.com/ontology/v1/context-queries"

payload = {
    "ontology_id": "<string>",
    "query": "<string>",
    "release_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "manifest_digest": "<string>",
  "max_depth": 1,
  "max_resources": 1,
  "max_tokens": 1,
  "refinement_hints": [
    "<string>"
  ],
  "release": "<string>",
  "release_id": "<string>",
  "resources": [
    {
      "api_name": "<string>",
      "artifact_id": "<string>",
      "definition": "<unknown>",
      "depth": 1,
      "kind": "<string>",
      "score": 1,
      "selected_because": [
        "term_match"
      ]
    }
  ],
  "token_estimate": 1,
  "truncated": true,
  "diagnostics": {
    "expanded_candidates": 1,
    "lexical_candidates": 1,
    "registry_candidates": 1,
    "release_candidates": 1,
    "returned_resources": 1
  }
}

{
  "code": "invalid_base64",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "alg_mismatch",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "access_denied",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "not_found",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "compressed_payload_too_large",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unsupported_content_encoding",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unprocessable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "internal_error",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "auth_unavailable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "request_timeout",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

Content-Encoding

enum<string>

Available options:

base64,

gzip, base64

Body

application/json

ontology_id

string

required

query

string

required

release_id

string

required

diagnostics

boolean

include

enum<string>[]

Available options:

object_types,

interface_types,

link_types,

shared_property_types,

action_types,

concept_schemes,

concepts

max_depth

integer | null

Required range: x >= 0

max_resources

integer | null

Required range: x >= 0

max_tokens

integer | null

Required range: x >= 0

Response

HTTP 200 response.

manifest_digest

string

required

max_depth

integer

required

Required range: x >= 0

max_resources

integer

required

Required range: x >= 0

max_tokens

integer

required

Required range: x >= 0

refinement_hints

string[]

required

release

string

required

release_id

string

required

resources

object[]

required

Show child attributes

token_estimate

integer

required

Required range: x >= 0

truncated

boolean

required

diagnostics

object | null

Show child attributes

Compile bounded release-consistent ontology context

curl --request POST \
  --url https://api.atlan.com/ontology/v1/context-queries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ontology_id": "<string>",
  "query": "<string>",
  "release_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ontology_id: '<string>', query: '<string>', release_id: '<string>'})
};

fetch('https://api.atlan.com/ontology/v1/context-queries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.atlan.com/ontology/v1/context-queries"

payload = {
    "ontology_id": "<string>",
    "query": "<string>",
    "release_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "manifest_digest": "<string>",
  "max_depth": 1,
  "max_resources": 1,
  "max_tokens": 1,
  "refinement_hints": [
    "<string>"
  ],
  "release": "<string>",
  "release_id": "<string>",
  "resources": [
    {
      "api_name": "<string>",
      "artifact_id": "<string>",
      "definition": "<unknown>",
      "depth": 1,
      "kind": "<string>",
      "score": 1,
      "selected_because": [
        "term_match"
      ]
    }
  ],
  "token_estimate": 1,
  "truncated": true,
  "diagnostics": {
    "expanded_candidates": 1,
    "lexical_candidates": 1,
    "registry_candidates": 1,
    "release_candidates": 1,
    "returned_resources": 1
  }
}

{
  "code": "invalid_base64",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "alg_mismatch",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "access_denied",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "not_found",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "compressed_payload_too_large",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unsupported_content_encoding",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unprocessable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "internal_error",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "auth_unavailable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "request_timeout",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

CLI

SDK

MCP

API

Compile bounded release-consistent ontology context

Authorizations

Headers

Body

Response