# Read a shared receipt's visual evidence - **OpenAPI Version:** `3.2.0` - **API Version:** `3.1.0` - **Contact:** Syndai ## Contents **Operations** - [GET /api/v1/public/receipts/{token}/evidence](#scalar-operation-get-apiv1publicreceiptstokenevidence) **Schemas** - [ChangeEvidence](#scalar-schema-changeevidence) - [EvidenceCriterion](#scalar-schema-evidencecriterion) - [EvidenceMedia](#scalar-schema-evidencemedia) - [EvidenceFlow](#scalar-schema-evidenceflow) - [EvidenceFlowStep](#scalar-schema-evidenceflowstep) - [EvidencePage](#scalar-schema-evidencepage) - [EvidenceUiFix](#scalar-schema-evidenceuifix) - [ProblemDetail](#scalar-schema-problemdetail) - [ExternalErrorCode](#scalar-schema-externalerrorcode) ## Servers - **URL:** `https://api.syndai.ai` ## Authentication - **CustomerApiKey**: HTTP bearer (`API Key`) Customer API key sent as a bearer token ## Tags ### Receipts Public, unauthenticated reads of a shared run receipt: the receipt, its visual evidence, white-label branding, and an embeddable SVG badge. The token in the share link is the credential; revoking the share makes every route 404. ## Operations ### Read a shared receipt's visual evidence - **Method:** `GET` - **Path:** `/api/v1/public/receipts/{token}/evidence` - **Operation ID:** `getPublicReceiptEvidence` - **Tags:** Receipts Returns the delivered change in pictures (before/after captures with short-lived media URLs) for a shared run. A revoked or unknown link returns 404. A shared run with nothing to show returns 200 with `missing_reason` explaining why. **Servers:** [Inherited servers](#scalar-context-global-servers) #### Authentication No authentication required. #### Path parameters - **`token` (required)**: `string` #### Responses ##### 200 Request fulfilled, document follows **Headers:** - **`cache-control`** `string` **Content type:** `application/json` [ChangeEvidence](#scalar-schema-changeevidence) **Generated example:** ```json { "criteria": [ { "before_card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "criterion_id": "", "flow": { "before": { "before": { "before": { "before": {}, "clip": {}, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": {}, "received": "", "status": "", "steps": [] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": {}, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "flow_missing": true, "label": "", "replay": "", "surface": "", "text": "" } ], "missing_reason": "", "pages": [ { "before_desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before_phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "change": "", "desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "route": "" } ], "ui_fix": { "after": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 } } } ``` ##### 400, 404 - `400` Bad request syntax or unsupported method - `404` Resource not found **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) RFC 7807 problem detail returned for public CaaS errors. **Generated example:** ```json { "code": "BUDGET_EXHAUSTED", "detail": null, "existing_run_id": null, "instance": null, "status": 1, "title": "", "type": "about:blank", "additionalProperty": "anything" } ``` ##### 429 Rate limit exceeded **Headers:** - **`Retry-After`** Seconds to wait before retrying the request `integer` **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) RFC 7807 problem detail returned for public CaaS errors. [Generated example](#scalar-example-2) ##### default Unexpected error **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) **Generated example:** ```json null ``` ## Schemas ### ChangeEvidence **Type:** `object` - **`criteria` (required)**: array of [EvidenceCriterion](#scalar-schema-evidencecriterion) - **`pages` (required)**: array of [EvidencePage](#scalar-schema-evidencepage) - **`missing_reason`**: `string | null` - **`ui_fix`**: [EvidenceUiFix](#scalar-schema-evidenceuifix) | `null` **Generated example:** ```json { "criteria": [ { "before_card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "criterion_id": "", "flow": { "before": { "before": { "before": { "before": {}, "clip": {}, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": {}, "received": "", "status": "", "steps": [] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": {}, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "flow_missing": true, "label": "", "replay": "", "surface": "", "text": "" } ], "missing_reason": "", "pages": [ { "before_desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before_phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "change": "", "desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "route": "" } ], "ui_fix": { "after": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 } } } ``` ### EvidenceCriterion **Type:** `object` - **`criterion_id` (required)**: `string`, format: `uuid` - **`flow_missing` (required)**: `boolean` - **`label` (required)**: `string` - **`text` (required)**: `string` - **`before_card`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`card`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`flow`**: [EvidenceFlow](#scalar-schema-evidenceflow) | `null` - **`replay`**: `string | null` - **`surface`**: `string | null` **Generated example:** ```json { "before_card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "card": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "criterion_id": "", "flow": { "before": { "before": { "before": { "before": { "before": {}, "clip": {}, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": {}, "received": "", "status": "", "steps": [] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": {}, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "flow_missing": true, "label": "", "replay": "", "surface": "", "text": "" } ``` ### EvidenceMedia **Type:** `object` - **`alt` (required)**: `string` - **`id` (required)**: `string`, format: `uuid` - **`kind` (required)**: `string` - **`truncated` (required)**: `boolean` - **`url` (required)**: `string` - **`url_expires_at` (required)**: `string`, format: `date-time` - **`height`**: `integer | null` - **`width`**: `integer | null` **Generated example:** ```json { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 } ``` ### EvidenceFlow **Type:** `object` - **`status` (required)**: `string` - **`steps` (required)**: array of [EvidenceFlowStep](#scalar-schema-evidenceflowstep) - **`before`**: [EvidenceFlow](#scalar-schema-evidenceflow) | `null` - **`clip`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`duration_ms`**: `integer | null` - **`failed_step`**: `integer | null` - **`failure`**: `string | null` - **`poster`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`received`**: `string | null` **Generated example:** ```json { "before": { "before": { "before": { "before": { "before": { "before": {}, "clip": {}, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": {}, "received": "", "status": "", "steps": [] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": {}, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] }, "clip": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "duration_ms": 1, "failed_step": 1, "failure": "", "poster": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "received": "", "status": "", "steps": [ { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ] } ``` ### EvidenceFlowStep **Type:** `object` - **`index` (required)**: `integer` - **`status` (required)**: `string` - **`title` (required)**: `string` - **`still`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` **Generated example:** ```json { "index": 1, "status": "", "still": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "title": "" } ``` ### EvidencePage **Type:** `object` - **`route` (required)**: `string` - **`before_desktop`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`before_phone`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`change`**: `string | null` - **`desktop`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` - **`phone`**: [EvidenceMedia](#scalar-schema-evidencemedia) | `null` **Generated example:** ```json { "before_desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before_phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "change": "", "desktop": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "phone": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "route": "" } ``` ### EvidenceUiFix **Type:** `object` - **`after` (required)**: [EvidenceMedia](#scalar-schema-evidencemedia) - **`before` (required)**: [EvidenceMedia](#scalar-schema-evidencemedia) **Generated example:** ```json { "after": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 }, "before": { "alt": "", "height": 1, "id": "", "kind": "", "truncated": true, "url": "", "url_expires_at": "", "width": 1 } } ``` ### ProblemDetail **Type:** `object` RFC 7807 problem detail returned for public CaaS errors. - **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"` Stable error codes surfaced to public CaaS clients. - **`status` (required)**: `integer` - **`title` (required)**: `string` - **`detail`**: `string | null`, default: `null` - **`existing_run_id`**: `string | null`, default: `null` - **`instance`**: `string | null`, default: `null` - **`type`**: `string`, default: `"about:blank"` **Generated example:** ```json { "code": "BUDGET_EXHAUSTED", "detail": null, "existing_run_id": null, "instance": null, "status": 1, "title": "", "type": "about:blank", "additionalProperty": "anything" } ``` ### ExternalErrorCode **Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"` Stable error codes surfaced to public CaaS clients.