Skip to content
bucker

API reference

essence-by-url

1 operation. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.

GET/orgs/{orgSlug}/projects/{projectSlug}/essence-by-url

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/essence-by-url
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
urlrequiredquerystringmin length 1, max length 2048

Response 200

{
  org: string
  project: string
  kind: "issue" | "release" | "alert_event" | "session" | "service" | "flag" | "host" | "funnel_step"
  id: string
  status: "ok" | "not_available"
  reason: string | null
  essence: {
    schemaVersion: "3.0.0"
    kind: "issue" | "release" | "alert_event" | "session" | "service" | "flag" | "host"
    id: string
    identity: {
      title: object
      detail: object | null
      org: string
      project: string
      url: string
    }
    state: {
      verdict: "failing" | "degraded" | "healthy" | "inactive" | "unknown"
      reasons: object[]
    }
    changes: {
      kind: string
      summary: object
      at: string
      ref: string | null
    }[]
    handles: {
      tool: string
      arguments: object
      priceTokens: integer
      scanClass: "none" | "bounded" | "scan"
    }[]
    notChecked: string[]
    freshness: {
      asOf: string | null
      generatedAt: string
      basis: "exact" | "rollup" | "estimate" | "not_measured"
    }
    emptiness: {
      reason: "no_data_in_window" | "filtered_out" | "not_ingested" | "retention_expired" | "scope_hidden" | "not_enough_data"
      nextCalls: object[]
    } | null
    estimatedTokens: integer
  } | null
  keys: Record<string, string>
  withheld: string[]
  quarantined: integer
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/essence-by-url \
  -H "authorization: Bearer $BUCKER_TOKEN"