Skip to content
bucker

API reference

evidence

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}/evidence/{kind}/{id}

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/evidence/{kind}/{id}
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
kindrequiredpath"issue" | "alert_event" | "correlation_group" | "change_event" | "investigation" | "metric_window" | "funnel_step" | "flag_change" | … 5 moreone of "issue" | "alert_event" | "correlation_group" | "change_event" | "investigation" | "metric_window" | "funnel_step" | "flag_change" | … 5 more
idrequiredpathstringmin length 1, max length 128

Response 200

{
  org: string
  project: string
  kind: "issue" | "alert_event" | "correlation_group" | "change_event" | "investigation" | "metric_window" | "funnel_step" | "flag_change" | … 5 more
  id: string
  status: "ok" | "not_available"
  reason: string | null
  header: {
    kind: "issue" | "alert_event" | "correlation_group" | "change_event" | "investigation" | "metric_window" | "funnel_step" | "flag_change" | … 5 more
    id: string
    title: {
      value: string
      trust: "untrusted" | "quarantined"
    }
    status: string | null
    at: string | null
    facts: Record<string, string | number | boolean | null>
    text: Record<string, object>
  } | null
  keys: Record<string, string>
  handles: {
    tool: string
    arguments: Record<string, string>
    returns: string
    priceTokens: integer
    scanClass: "none" | "bounded" | "scan"
    reaches: "issue" | "trace" | "session" | "release" | "flag" | "change" | "check"[]
  }[]
  withheld: {
    tool: string
    reason: {
      value: string
      trust: "untrusted" | "quarantined"
    } | null
  }[]
  assembly: {
    calls: integer
    tokens: integer
    tools: string[]
    uncovered: "issue" | "trace" | "session" | "release" | "flag" | "change" | "check"[]
  } | null
  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}/evidence/{kind}/{id} \
  -H "authorization: Bearer $BUCKER_TOKEN"