Get an entity
Gets an entity.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets an entity.
Not available yet. Sylphx Knowledge is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities/entity - Scope
knowledge:read - Effect
read— nothing is written. - Collection entities
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the entity to get. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/entities/{entity}. |
uid | string | ken_<26 base32>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
entity_type | string | The type: a core type (person, organisation, customer, contact, product, project, document, decision, playbook, case, topic) or a type of an accepted Knowledge Schema, <schema>.<type>. Required. |
title | string | The name people use for it. Required. |
aliases | string[] | Other names it is known by; at most 50. |
properties | struct | Properties, valid against the type's JSON Schema. |
external_ids | ExternalId[] | Identifiers in other systems. Two writes with the same external id in one graph are the same entity (deterministic resolution). At most 50. |
space | string | The space the entity was first stated in. Required. |
provenance | Provenance | Where it came from and who wrote it. Output only. |
lifecycle | EntityLifecycle | Whether the entity stands on its own or was merged into another. Output only. One of active, merged. |
survivor | string | The entity this one was merged into, while lifecycle is ENTITY_LIFECYCLE_MERGED. Output only. |
merged_entities | string[] | The entities merged into this one; each can be split back out. Output only. |
create_time | timestamp | When the entity was first recorded. Output only. |
update_time | timestamp | When the entity last changed. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
ExternalId
| Field | Type | What it is |
|---|---|---|
kind | string | The kind of identifier: email, phone, auth_subject, channel_user, account, or a caller's own kind. Required. |
value | string | The identifier, normalised (a lowercase email, an E.164 phone number). Required. |
Provenance
| Field | Type | What it is |
|---|---|---|
principal | string | The principal the write is attributed to, as a share subject (user:<id>, end_user:<id>): the member or end user an agent or app acts for. Set by the server from the caller's credential. Output only. |
actor | string | The caller that made the write when it is not the principal: an agent (agent:<id>), an app key (api_key:<id>) or a connector. Output only. |
channel | Channel | The path the write took. Output only. One of api, tool, import, extraction. |
method | SourceMethod | How the content was produced; default SOURCE_METHOD_STATED. Only the service writes SOURCE_METHOD_EXTRACTED. One of stated, extracted, imported. |
references | SourceRef[] | References to where the content came from: a run and step, a work item, a message, a URL. At most 20. |
model | string | For an extracted record, the model id that extracted it. Output only. |
confidence | double | For an extracted record, the extractor's confidence, 0 to 1. Output only. |
SourceRef
| Field | Type | What it is |
|---|---|---|
uri | string | A URI: a URL, or a URN of a platform record such as a Workflows run step. Required. |
label | string | A short label to show with a citation. |
pinned_version | string | Immutable version of the source observed when this claim was recorded. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entities/entity" \
-H "Authorization: Bearer $SYLPHX_API_KEY"