---
search:
  tags:
    - Embeddings
    - POST
seo:
  description: >-
    Register an embedding space under the id its spec gives it, or return the
    space… Reference for the POST /v1/embeddings/spaces endpoint in the Roboto
    REST API.
sidebar:
  label: Register embedding space
  badge: POST
title: Register embedding space
type: openapi-operation
---
Register an embedding space under the id its spec gives it, or return the space registered under that id.

The id is the SHA-256 of the spec's canonical JSON (sorted keys, no whitespace), so registering the same spec
with the same values again returns that space unchanged. The response carries the id, and leaves
``producer_state`` out; ``GET v1/embeddings/spaces/id/<space_id>?include_producer_state=true`` returns it.

Raises:
    RobotoInvalidRequestException: ``dim`` is outside 1 to 4,000, ``levels`` repeats a level, the window grid
        is missing for a space with window rows or given for one without, or the body has a field not listed.
    RobotoConflictException: The org has the space registered with another ``kind``, ``dim``, ``levels``,
        grid, ``name`` or ``display``.

#### Access control
 - requires_org
 - Restricted tokens need the API scope `api.everything_else`

`POST /v1/embeddings/spaces`

**Request body** (`application/json`, required)

- `name` (string, required)
- `kind` (string)
- `dim` (integer, required)
- `levels` (string[], required)
- `window_ns` (integer | null)
- `stride_ns` (integer | null)
- `producer` (string, required)
- `spec` (object, required)
- `display` (object | null)
- `producer_state` (object | null)

Request body example:

```json
{
  "name": "string",
  "kind": "embedding",
  "dim": 0,
  "levels": [
    "window"
  ],
  "window_ns": null,
  "stride_ns": null,
  "producer": "string",
  "spec": {},
  "display": null,
  "producer_state": null
}
```

**Responses**

- `200` — OK
- `400` — Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit. The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.
- `401` — Thrown when authentication fails
- `403` — Thrown if an operation would exceed a user or org level limit.
- `404` — Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.
- `409` — Thrown if there is a conflict between a resource you're creating and another existing resource
- `410` — Thrown if a resource is missing or expired.
- `500` — An error the platform reported that this SDK release cannot resolve to a specific exception class. Reported for an element of a :py:class:\`\~roboto.http.BatchResponse\` whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text. The error envelope carries no status code, so \`\`http\_status\_code\`\` reports the 500 inherited from :py:class:\`RobotoDomainException\` rather than the status the failure actually had.
- `501` — Thrown by shimmed out APIs which have not yet been implemented
- `503` — Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.
- `504` — Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.
- `507` — Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

Response example, 200:

```json
{
  "data": {
    "org_id": "string",
    "space_id": "string",
    "name": "string",
    "kind": "embedding",
    "dim": 0,
    "levels": [
      "string"
    ],
    "window_ns": null,
    "stride_ns": null,
    "retired": false,
    "producer": "string",
    "spec": {},
    "display": null,
    "producer_state": null,
    "created_by": "string",
    "created": "2019-08-24T14:15:22Z",
    "modified": "2019-08-24T14:15:22Z"
  }
}
```
