API REFERENCE

Claim guest context

On this page

POST/api/context/guest/claim

Requires the original guest cookie plus verified account authentication. Optionally claims into an authorized organization. Transfers saved metadata without refetching it; an in-progress worker finishes into the claimed destination. Repeated claims by the same account and destination return the same request ID. Another account cannot claim it. Existing matching identities and customer corrections are preserved. No artist ownership claim is implied. Signup UI integration must call this endpoint after authentication. The Recoup app provides a /context entry page and claims into the personal account after login. A failed extraction remains retryable through the same claim receipt. No completion email or website is generated by this flow.

Authentication

recoup_context_guest in cookie

BearerAuth bearer

recoup_context_guest in cookie

x-api-key in header

Request

cURL

curl --request POST \
  --url 'https://api.recoupable.dev/api/context/guest/claim' \
  --header 'recoup_context_guest: YOUR_API_KEY' \
  --header 'Origin: YOUR_VALUE' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "claim"
}'

Try it

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

API keyrecoup_context_guest header

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

Originheader · stringrequired

Request bodyapplication/json

cURL for this request

curl --request POST \
  --url 'https://recoup-api.vercel.app/api/context/guest/claim' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "claim"
}'

Parameters

Header parameters

Originstringrequired

The configured funnel origin. This is a browser session flow, not a public unauthenticated MCP tool.

Request body required

application/json

actionstring · enumrequired

Values: "claim"

organization_idstring

format: uuid

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": "Claim guest context after sign-in",
  "description": "Requires the original guest cookie plus verified account authentication. Optionally claims into an authorized organization. Transfers saved metadata without refetching it; an in-progress worker finishes into the claimed destination. Repeated claims by the same account and destination return the same request ID. Another account cannot claim it. Existing matching identities and customer corrections are preserved. No artist ownership claim is implied. Signup UI integration must call this endpoint after authentication. The Recoup app provides a /context entry page and claims into the personal account after login. A failed extraction remains retryable through the same claim receipt. No completion email or website is generated by this flow.",
  "security": [
    {
      "GuestSession": [],
      "BearerAuth": []
    },
    {
      "GuestSession": [],
      "ApiKey": []
    }
  ],
  "parameters": [
    {
      "name": "Origin",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "The configured funnel origin. This is a browser session flow, not a public unauthenticated MCP tool."
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "action"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "claim"
              ]
            },
            "organization_id": {
              "type": "string",
              "format": "uuid"
            }
          }
        }
      }
    }
  },
  "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."
    }
  }
}