Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | The name of the project to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}. |
uid | string | prj_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ProjectSpec | Desired state. Required. |
status | ProjectStatus | Observed state. 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. |
#ProjectSpec
| Field | Type | What it is |
|---|---|---|
slug | string | Unique within the org. Required. |
limits | UsageLimits | Usage limits shared by every key of the project; a key's own limits only tighten them. Unset means no project-level limit. |
#ProjectStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
expire_time | timestamp | When an unclaimed project expires; unset once claimed. Output only. |
#UsageLimits
| Field | Type | What it is |
|---|---|---|
ai_spend | AiSpendLimit | Sylphx AI spend. |
requests_per_minute | int32 | Requests per minute. |
ai_tokens_per_minute | int64 | Sylphx AI tokens per minute, input and output together. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#AiSpendLimit
| Field | Type | What it is |
|---|---|---|
monthly_usd_minor | int64 | Most spend per calendar month, in USD cents. |
daily_usd_minor | int64 | Most spend per calendar day, in USD cents. |
#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" \
-H "Authorization: Bearer $SYLPHX_API_KEY"