Skip to content
Docs
Esc
↑↓navigate↵open⌘Jpreview

Renew a Frame session

Re-evaluates the Link, target, path, origin, and access epochs without spending another Link use.

POST/v1/spaces/{spaceId}/share-links/{linkId}/frame-session/renew
Authorization
__Host-better-auth.session_tokenAPI key · cookierequired

Signed-in browser session, set by the dashboard sign-in flow. An operation that declares only this one needs a person behind the request: an API key or machine credential is refused. The same session token is also accepted as Authorization: Bearer.

Path parameters
spaceIdstringrequired
linkIdstringrequired
Request body
requiredapplication/json
sessionTokenstringrequired
min length 32 · max length 16384
Responses
200

Response for status 200

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

dataobjectrequired
Show properties
spaceIdstringrequired
matches ^(spc_)[A-Za-z0-9]+$
linkIdstringrequired
matches ^(lnk_)[A-Za-z0-9]+$
linkRevisionintegerrequired
max 9007199254740991
parentOriginstring<uri>required
max length 2000
pathstringrequired
min length 1 · max length 1024
targetobjectrequired
Show properties
One of:
object
kindstringrequired
versionIdstringrequired
matches ^(ver_)[A-Za-z0-9]+$
routeRevisionstringrequired
matches ^sha256:[a-f0-9]{64}$
object
kindstringrequired
versionIdstringrequired
matches ^(ver_)[A-Za-z0-9]+$
object
kindstringrequired
branchstringrequired
min length 1 · max length 255
versionIdstringrequired
matches ^(ver_)[A-Za-z0-9]+$
branchRevisionstringrequired
matches ^sha256:[a-f0-9]{64}$
surfacestringrequired
Allowed:wordpress.editorwordpress.preview
accessstringrequired
Allowed:publicprivate
urlstring<uri>required
sessionTokenstringrequired
min length 32
expiresAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
default

Problem details (RFC 9457). Any 4xx/5xx response is one application/problem+json document.

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

typestringrequired

Problem type URI resolving to the error docs page. The server derives it mechanically from code against the docs origin.

titlestringrequired

Short human-readable summary of the problem type. The server derives it mechanically from code.

statusintegerrequired

HTTP status code of this response, repeated in the body.

min -9007199254740991 · max 9007199254740991
detailstringrequired

Human-readable failure explanation for this occurrence.

codestringrequired

Stable snake_case error code naming the failed public contract.

pointerstring

RFC 6901 JSON Pointer into the failing request field, for example "/files/37/path", on validation failures.

detailsobject

Machine-readable context for the error code.

fixstring

One sentence on what to do about this error code, the same text as the type page. Read it before retrying.

suggestionsstring[]

Actionable recovery steps safe to show in dashboards, SDKs, and CLI output.

nextstring[]

Copy-pasteable commands or API requests an agent can run next.

requestIdstringrequired

The request id to quote when contacting support.

Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.spacefast.com/v1/spaces/string/share-links/string/frame-session/renew' \
  -H 'Cookie: __Host-better-auth.session_token=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionToken": "stringstringstringstringstringst"
}'
Response
{
  "$schema": "http://example.com",
  "data": {
    "spaceId": "string",
    "linkId": "string",
    "linkRevision": 1,
    "parentOrigin": "http://example.com",
    "path": "string",
    "target": {
      "kind": "live",
      "versionId": "string",
      "routeRevision": "string"
    },
    "surface": "wordpress.editor",
    "access": "public",
    "url": "http://example.com",
    "sessionToken": "stringstringstringstringstringst",
    "expiresAt": "2019-08-24T14:15:22Z"
  }
}

Was this page helpful?