Recoup

Get started with Recoup.

API REFERENCE

Read guest context

On this page
GET/api/context/guest

Returns metadata and status for the current unclaimed, unexpired guest session. Guest access ends when claimed. Unclaimed work expires after seven days.

Authentication

recoup_context_guest in cookie

Request

cURL
curl --request GET \
  --url 'https://api.recoupable.dev/api/context/guest' \
  --header 'recoup_context_guest: YOUR_API_KEY'

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

Kept in this browser tab only and cleared when it closes.

cURL for this request
curl --request GET \
  --url 'https://recoup-api.vercel.app/api/context/guest'

Responses

200Saved guest context or claim receipt.

No response body schema is specified.

400Invalid request.

No response body schema is specified.

401Guest session or account authentication missing.

No response body schema is specified.

403Origin or workspace access denied.

No response body schema is specified.

409Operation unavailable; retry the same input and session.

No response body schema is specified.

503Guest context is disabled.

No response body schema is specified.

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download context.json
View operation source
json
{
  "summary": "Read guest context",
  "description": "Returns metadata and status for the current unclaimed, unexpired guest session. Guest access ends when claimed. Unclaimed work expires after seven days.",
  "security": [
    {
      "GuestSession": []
    }
  ],
  "responses": {
    "200": {
      "description": "Saved guest context or claim receipt."
    },
    "400": {
      "description": "Invalid request."
    },
    "401": {
      "description": "Guest session or account authentication missing."
    },
    "403": {
      "description": "Origin or workspace access denied."
    },
    "409": {
      "description": "Operation unavailable; retry the same input and session."
    },
    "503": {
      "description": "Guest context is disabled."
    }
  }
}