Recoup

Get started with Recoup.

API REFERENCE

Start guest context

On this page
POST/api/context/guest

Feature-flagged metadata pilot. Saves a Spotify track URL in a temporary workspace before signup. Uses an HttpOnly seven-day cookie; only its hash is stored. One URL per guest session and 100 new guest workspaces per day globally. Extracts artist and release metadata only. Does not run paid enrichment, generate a site, or send email. Serve through the same-origin funnel; cross-site cookie integration is not provided. Retry the same URL and cookie to resume dispatch.

Authentication

This endpoint does not require authentication.

Request

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

Try it

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

cURL for this request
curl --request POST \
  --url 'https://recoup-api.vercel.app/api/context/guest' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "start",
  "url": "string"
}'

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: "start"

urlstringrequired

format: uri

Responses

200Saved guest context or claim receipt.

No response body schema is specified.

202Guest work saved and workflow dispatched. Preserve Set-Cookie for status and claim.

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": "Start guest context extraction",
  "description": "Feature-flagged metadata pilot. Saves a Spotify track URL in a temporary workspace before signup. Uses an HttpOnly seven-day cookie; only its hash is stored. One URL per guest session and 100 new guest workspaces per day globally. Extracts artist and release metadata only. Does not run paid enrichment, generate a site, or send email. Serve through the same-origin funnel; cross-site cookie integration is not provided. Retry the same URL and cookie to resume dispatch.",
  "security": [],
  "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",
            "url"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "start"
              ]
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Saved guest context or claim receipt."
    },
    "202": {
      "description": "Guest work saved and workflow dispatched. Preserve Set-Cookie for status and claim."
    },
    "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."
    }
  }
}