---
agentTools:
  projectIndex: https://elai.readme.io/llms.txt
---

# Send an ICE candidate

Forwards one trickle-ICE candidate to the GPU host. Call it once per candidate the browser emits.

```curl Request
curl -X POST 'https://apis.elai.io/api/v1/streams/candidate/66a1f0c2b7cd13032a9c6200' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "candidate": "<candidate>"
}'
```

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Elai Public API",
    "version": "1.0",
    "description": "Every endpoint below is served under `https://apis.elai.io/api/v1`.\n\n## Authentication\n\nSend your workspace API token as a bearer token on every request:\n\n```\nAuthorization: Bearer <your-api-token>\n```\n\nGenerate and rotate the token in the Elai web app under **Settings → API**, or through\n`POST /generateToken`. The token is scoped to one **workspace** and authenticates as that\nworkspace's admin user — it is not tied to an individual person, and it carries admin rights\ninside that workspace.\n\nA request with a missing, unknown or revoked token gets a bare `401` with no response body.\n\n> **Organizations on the Unlimited plan cannot use the API.** Their requests are rejected with the\n> same bare `401` as an invalid token, with nothing to distinguish the two. If a valid, freshly\n> generated token returns `401` on every endpoint, check the plan first.\n\n## Errors\n\nFailures carry a JSON body of the shape `{ \"message\": \"...\" }`. Validation failures on the newer\nendpoints may add an `errors` array naming the offending fields. `401` is the exception: it has no\nbody at all.\n\nBoth render endpoints are **fire-and-forget** — they queue work and return immediately, so a\n`200` means \"accepted\", not \"rendered\". Render failures surface only through the `video_error`\nwebhook, never as an HTTP error on the call that started the render.\n\n## Scope\n\nThis reference is generated from the running code rather than maintained by hand, so it cannot\nquietly fall behind the API it describes. It documents 96 operations across the\n`/api/v1` surface.\n\nEndpoints are grouped by subject in the sidebar. If something you need is missing, or an endpoint\ndoes not behave as described here, tell us.\n\n---\n\n_Generated from `chore/web-4760/api-v1-reference-build` at `5289745d` on 2026-09-04._"
  },
  "servers": [
    {
      "url": "https://apis.elai.io/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "SECRET_KEY"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Human-readable explanation of the failure."
          }
        }
      }
    },
    "parameters": {
      "StreamId": {
        "name": "streamId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "Stream id returned by `POST /streams`."
      }
    },
    "responses": {
      "StreamNotUsable": {
        "description": "`streamId` is not a valid ObjectId, there is no such stream, it belongs to another workspace, or it is already closed. All four cases return `400`.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "message": "Seems like this stream is already closed. Please request new stream."
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/streams/candidate/{streamId}": {
      "post": {
        "tags": [
          "Live streams"
        ],
        "summary": "Send an ICE candidate",
        "description": "Forwards one trickle-ICE candidate to the GPU host. Call it once per candidate the browser emits.",
        "parameters": [
          {
            "$ref": "#/components/parameters/StreamId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "candidate": {
                    "type": "object",
                    "description": "The ICE candidate.",
                    "additionalProperties": true
                  }
                },
                "required": [
                  "candidate"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Candidate forwarded.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/StreamNotUsable"
          }
        },
        "operationId": "send-stream-candidate"
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "tags": [
    {
      "name": "Live streams",
      "description": "WebRTC live avatars: open a session, drive the WebRTC handshake, and make the avatar speak. Billed at 0.5x normal minutes."
    }
  ],
  "_id": {
    "buffer": {
      "0": 106,
      "1": 154,
      "2": 229,
      "3": 101,
      "4": 201,
      "5": 178,
      "6": 243,
      "7": 252,
      "8": 223,
      "9": 58,
      "10": 69,
      "11": 151
    }
  }
}
````