Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Get a generation

Gets a generation: one Sylphx AI call.

Gets a generation: one Sylphx AI call.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/generations/generation
  • Scope observability:read
  • Effect read — nothing is written.
  • Collection generations

#Request

FieldTypeWhat it is
namestringThe name of the generation to get. Required.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/generations/{generation}.
uidstringgen_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
trace_idstringThe W3C trace id (32 hex); the caller's own when it sent traceparent. Output only.
span_idstringThe W3C span id (16 hex) of the gateway's span. Output only.
operationstringgen_ai.operation.name, for example chat, embeddings or generate_content. Output only.
api_surfacestringThe wire the call used: responses, messages, chat_completions, embeddings, images, audio or realtime_transcription. Output only.
request_modelstringThe catalogue model id the caller named, for example anthropic/claude-sonnet-5.5. Output only.
response_modelstringThe catalogue model id that answered. Output only.
response_idstringThe response id (resp_..., msg_... or chatcmpl-...). Output only.
api_keystringThe key that made the call, as a resource name. Output only.
outcomeGenerationOutcomeHow the call ended. Output only. One of succeeded, failed, cancelled.
finish_reasonsstring[]gen_ai.response.finish_reasons, for example stop or length. Output only.
error_typestringerror.type when the call failed: the public error code, for example rate_limited. Output only.
input_tokensint64Input tokens, cached ones included. Output only.
output_tokensint64Output tokens, reasoning ones included. Output only.
cache_read_input_tokensint64Input tokens read from the prompt cache. Output only.
cache_write_input_tokensint64Input tokens written to the prompt cache. Output only.
reasoning_output_tokensint64Output tokens spent on reasoning. Output only.
price_usdstringWhat the call was charged in USD, as a decimal string, for example 0.000420; the same value as the response's usage.sylphx.price. Output only.
start_timetimestampWhen the gateway received the call. Output only.
end_timetimestampWhen the last byte of the answer was sent. Output only.
time_to_first_chunkdurationFrom receipt to the first output chunk; unset when nothing streamed. Output only.
streamedboolWhether the answer was streamed. Output only.
data_policystringThe data policy the call ran under: standard, zdr or training. Output only.
tagsmap<string, string>The caller's tags (Sylphx-Tags and the request's metadata), at most 64; filter as tags.<key> = "value". Output only.
end_userstringThe caller's own end-user id (user or safety_identifier), as sent. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/generations/generation" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"