---
updatedAt: 2026-08-28T21:44:43.000Z
agentTools:
  projectIndex: https://docs-api.immersity.ai/llms.txt
---

# Stereo SBS

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/sbs": {
      "post": {
        "operationId": "TransactionController_generateStereoSbs",
        "x-codeSamples": [
          {
            "label": "Python",
            "lang": "Python",
            "source": "\nimport uuid\nimport requests\ncorrelation_id = str(uuid.uuid4())\nrequests.post(\n    'https://api.immersity.ai/api/v1/sbs', \n    headers={\n        'Authorization': 'Bearer {access_token}'  # acquired in previous step\n    },\n    json={\n        'correlationId': correlation_id,\n        'inputImageUrl': ORIGINAL_IMAGE_URL,  # this can be any image you want to get disparity for\n        'inputDisparityUrl': disparity_presigned_url,  # acquired in previous step\n        'resultPresignedUrl': put_sbs_presigned_url  # acquired in previous step\n    },\n    timeout=5 * 60  # expires in 5 min\n)"
          },
          {
            "label": "Node.js",
            "lang": "javascript",
            "source": "const uuid = require('uuid');\nconst axios = require('axios');\n\nconst correlationId = uuid.v4();\n\naxios.post(\n    'https://api.immersity.ai/api/v1/sbs',\n    {\n        correlationId,\n        inputImageUrl: ORIGINAL_IMAGE_URL, // this can be any image you want to get disparity for\n        inputDisparityUrl: disparityPresignedUrl, // acquired in previous step\n        resultPresignedUrl: putSbsPresignedUrl, // acquired in previous step\n    },\n    {\n        headers: {\n            Authorization: 'Bearer {accessToken}', // acquired in previous step\n        },\n        timeout: 5 * 60 * 1000, // expires in 5 min\n    });\n    "
          }
        ],
        "summary": "Stereo SBS",
        "description": "",
        "parameters": [],
        "requestBody": {
          "required": true,
          "description": "The input parameters for the SBS generation",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RESTStereoSbsGenerationParams"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request has succeeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RESTAPICallResult"
                }
              }
            }
          },
          "400": {
            "description": "The request has invalid parameters"
          },
          "401": {
            "description": "Returned if the user is not authenticated or authentication parameters are invalid"
          },
          "402": {
            "description": "Returned it there is not enough credit balance"
          }
        },
        "tags": [
          "Media Transformation"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "Immersity Cloud API",
    "description": "Immersity Cloud APIs provide a seamless and efficient way to leverage the power of computer vision and generate estimated disparity maps from 2D images. With just a simple API call, you can extract valuable depth information from your images, revealing the relative distances of objects in the scene.\n\nOur first API endpoint allows you to submit a 2D image and receive an estimated disparity map as the output. This disparity map highlights the variations in pixel disparities, enabling you to perceive the scene's depth and spatial layout. It opens up possibilities for applications such as 3D reconstruction, depth-based analysis, and more.\n\nBut that's not all! We go a step further by offering a second API endpoint that takes estimated disparity map and creates stunning 3D animations. Our API generates smooth and realistic 3D animations that bring your static images to life. With fine gain control over how obejcts should move within the scene, this unlocks a whole new realm of visual storytelling. \n\nOur REST APIs are designed to be user-friendly, scalable, and efficient, ensuring that you can seamlessly integrate them into your existing workflows or develop new applications. Experience the power of our APIs and unlock the potential of disparity maps and 3D animations in your projects today.\n\nYou will need Client ID & secret to access the APIs. Please refer to [Immersity Cloud Documentation](https://docs-api.immersity.ai/docs/getting-started) for more information. \n\nIf you have feedback or encounter any issues with the API, please reach out on [Discord](https://discord.gg/immersityai)",
    "version": "3.1.1",
    "termsOfService": "https://www.immersity.ai/legal/terms-conditions"
  },
  "tags": [
    {
      "name": "Media Transformation",
      "description": ""
    }
  ],
  "servers": [
    {
      "url": "https://api.immersity.ai"
    },
    {
      "url": "https://api.leiapix.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "RESTAPICallResult": {
        "type": "object",
        "properties": {
          "correlationId": {
            "type": "string",
            "description": "Unique query identifier",
            "example": "123e4567-e89b-12d3-a456-426614174000"
          },
          "resultPresignedUrl": {
            "type": "string",
            "description": "Presigned url where processing result had been uploaded",
            "example": "https://s3.eu-central-1.amazonaws.com/3d-photo-api-dev-output/1.jpg"
          }
        },
        "required": [
          "correlationId",
          "resultPresignedUrl"
        ]
      },
      "RESTStereoSbsGenerationParams": {
        "type": "object",
        "properties": {
          "inputImageUrl": {
            "type": "string",
            "description": "Readable input image url",
            "example": "https://..."
          },
          "resultPresignedUrl": {
            "type": "string",
            "description": "Presigned URL where the service should write the results to. The URL MUST have 'PUT' permission so the service can write the result to. For more details about signed URLs, please refer to your respective cloud providers.",
            "example": "https://..."
          },
          "correlationId": {
            "type": "string",
            "description": "UUID to correlate this request. This must be unique for each request. If not provided, the service will generate one",
            "example": "4d4eb584-a5cd-453b-8b67-567c1df26cb4"
          },
          "inputDisparityUrl": {
            "type": "string",
            "description": "Readable input disparity url",
            "example": "https://..."
          },
          "width": {
            "type": "number",
            "description": "Output image width",
            "example": 600,
            "default": "Preserves original image width"
          },
          "height": {
            "type": "number",
            "description": "Output image height",
            "example": 450,
            "default": "Preserves original image height"
          },
          "gain": {
            "type": "number",
            "description": "Floating point gain value",
            "maximum": 10,
            "minimum": 0,
            "default": "Gain is estimated automatically based on input image for best results"
          },
          "gainMultiplier": {
            "type": "number",
            "description": "A floating point number which is multiplied by gain",
            "maximum": 10,
            "minimum": 0
          },
          "convergence": {
            "type": "number",
            "description": "This changes the overall depth of the image to place objects in front of the screen or behind the screen or somewhere in between. It ranges from -1 to 1.",
            "maximum": 1,
            "minimum": -1,
            "default": "Convergence is estimated automatically based on input image for best results"
          },
          "outputType": {
            "type": "string",
            "description": "Output type. Default is SBS",
            "enum": [
              "sbs",
              "anaglyph",
              "spatial"
            ],
            "default": "sbs"
          }
        },
        "required": [
          "inputImageUrl"
        ]
      }
    }
  },
  "externalDocs": {
    "description": "Find out more about Immersity Cloud",
    "url": "https://docs-api.immersity.ai/docs/getting-started"
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```