> This page is for API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.spreadspace.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server. # Create embed session POST https://api.spreadspace.app/api/embed/sessions Content-Type: application/json Mints a short-lived embed session token bound to one loan. With `scopes` omitted the session is read-only and carries the standard read set (`documents:read`, `extractions:read`, `spreads:read`), whatever the key holds, and no scope check can fail the mint. Named read scopes are granted by mint authority. A named write (`documents:write`, `extractions:write`, `extractions:edit`, `spreads:write`) is granted only if the key holds it, or the mint fails with 400 `embed_scope_exceeds_key`; a named scope an embed session cannot carry fails with 400 `embed_scope_not_allowed`. Requires a plan that includes the embedded review UI; other plans get a 403. Requires the `embed:write` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/embed/create ## Authentication - `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication). ## Request ### Headers - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ### Body (application/json) This endpoint expects a CreateEmbedSessionRequest. - `loan_id` (string, required) - `scopes` (list of string, optional, nullable) - `expires_in_seconds` (integer, optional, nullable) - `external_user_id` (string, optional, nullable) — Optional opaque, stable identifier for the end user you are embedding for. Supply it and that user's saved work persists across their sessions; omit it and the session keeps nothing. Max 256 characters after trimming, and a blank value is rejected rather than ignored. - `display_name` (string, optional, nullable) — Reserved. Stored with the end user's id, not shown anywhere yet. Requires `external_user_id` (a label on its own is a 400). Control characters are stripped and the value trimmed; max 120 characters, and a blank value is rejected rather than ignored. ## Response ### 200 OK - `embed_token` (string, required) - `session_id` (string, required) - `expires_at` (datetime, required) - `loan_id` (string, required) - `borrower_id` (string, required) - `scopes` (list of string, required) - `persistence` (string, required) — How far the end user's work survives this session. `user` means the mint carried an `external_user_id`, so saved spreads, preferences and memo templates come back on that user's next session. `session` means it did not, so everything the end user arranges is discarded when the frame unloads. Always present. - `external_user_id` (string, optional, nullable) — Echo of the request's `external_user_id`, trimmed. Omitted when the mint carried no end-user id. - `display_name` (string, optional, nullable) — Echo of the request's `display_name` as stored, with control characters stripped and the value trimmed. Omitted when the mint carried no label. ## Errors ### 400 Bad Request Error Bad request: validation failed, the cursor is malformed, or the API version is unknown. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 401 Unauthorized Error Unauthorized: the bearer token or API key is missing or invalid. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 402 Payment Required Error Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 403 Forbidden Error Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 404 Not Found Error Not found: the resource does not exist or is not visible to the calling tenant. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 429 Too Many Requests Error Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 500 Internal Server Error Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ## Types ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message. - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets. - `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings. ## Examples **Request** ```json { "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a" } ``` **Response** ```json { "embed_token": "ss_embed_1f2e3d4c5b6a798081726354453627180f1e2d3c4b5a6978", "session_id": "es_9f8b7c6d5e4a3b2c1d0e4a5b", "expires_at": "2024-01-15T10:30:00.708871+00:00", "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a", "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4", "scopes": [ "documents:read", "extractions:read", "spreads:read" ], "persistence": "session" } ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/embed/sessions" payload = { "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/embed/sessions'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"loan_id":"9f8b7c6d5e4a3b2c1d0e4f5a"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/embed/sessions" payload := strings.NewReader("{\n \"loan_id\": \"9f8b7c6d5e4a3b2c1d0e4f5a\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.spreadspace.app/api/embed/sessions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"loan_id\": \"9f8b7c6d5e4a3b2c1d0e4f5a\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.spreadspace.app/api/embed/sessions") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"loan_id\": \"9f8b7c6d5e4a3b2c1d0e4f5a\"\n}") .asString(); ``` ```php request('POST', 'https://api.spreadspace.app/api/embed/sessions', [ 'body' => '{ "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/embed/sessions"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"loan_id\": \"9f8b7c6d5e4a3b2c1d0e4f5a\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/embed/sessions")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```