Skip to content
Console
On this page

Get a project

Gets a project.

Gets a project.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop
  • Scope access:read
  • Effect read — nothing is written.
  • Collection projects

Request

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

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}.
uidstringprj_<cell><ulid>; equals the name segment. Output only.
metaResourceMetaResource metadata.
specProjectSpecDesired state. Required.
statusProjectStatusObserved state. 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.

ProjectSpec

FieldTypeWhat it is
slugstringUnique within the org. Required.
limitsUsageLimitsUsage limits shared by every key of the project; a key's own limits only tighten them. Unset means no project-level limit.
declared_keystringDeclared project identity, when managed by a project declaration. This is the exact declaration key, for example sylphx-notify. Output only.
namestringThe project's human-readable name, independent of its generated slug. Output only.

ProjectStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
expire_timetimestampWhen an unclaimed project expires; unset once claimed. Output only.

UsageLimits

FieldTypeWhat it is
ai_spendAiSpendLimitSylphx AI spend.
requests_per_minuteint32Requests per minute.
ai_tokens_per_minuteint64Sylphx AI tokens per minute, input and output together.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

AiSpendLimit

FieldTypeWhat it is
monthly_usd_minorint64Most spend per calendar month, in USD cents.
daily_usd_minorint64Most spend per calendar day, in USD cents.

Errors

Every error arrives in the body Errors describes.

Examples

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