Manage Captures

The Teleport API allows you to manage your uploaded captures using the capture resource. Here are the remaining endpoints you can use: listing all captures, editing a capture, and deleting a capture.

Authentication

All requests require a valid AUTH_TOKEN to authenticate the requests to the API. Read about how to obtain the token in the authentication page.

---

1. List Captures

Retrieve all captures you have uploaded.

Endpoint:

GET /api/v1/captures

Example curl request:

curl -X GET "https://teleport.varjo.com/api/v1/captures" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example response:

[
  {
    "eid": "...",
    "sid": "...",
    "name": "My Capture",
    "created": "2025-10-06T18:55:42.733421",
    "uploaded": "2025-10-06T18:55:44.364236",
    "state": "READY",
    "error_reason": null,
    "state_description": null,
    "error_reason_slug": null,
    "preview_urls": {
      "432x576": "...",
      "897x1196": "..."
    },
    "preview_url": null,
    "viewer_url": "https://teleport.varjo.com/captures/...",
    "share_url": "https://teleport.varjo.com/captures/...",
    "share_link": "https://teleport.varjo.com/share/...",
    "gif_url": "...",
    "video_url": "...",
    "share_video_url": "...",
    "is_public": false
  },
  ...
]

💡 Tip: The response is a JSON array containing all captures your account own.

---

2. Edit Capture

Update attributes of an existing capture.

Endpoint:

PUT /api/v1/captures/EID

Replace EID with the capture identifier (eid) obtained when creating the capture or listing captures.

Example curl request:

curl -X PUT "https://teleport.varjo.com/api/v1/captures/EID" \
  -H "Authorization: Bearer AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "updated_capture_name.zip"
  }'

Example response:

{
  "eid": "...",
  "sid": "...",
  "name": "updated_capture_name.zip",
  "created": "2025-10-06T18:55:42.733421",
  "uploaded": "2025-10-06T18:55:44.364236",
  "state": "READY",
  "error_reason": null,
  "state_description": null,
  "error_reason_slug": null,
  "preview_urls": {
    "432x576": "...",
    "897x1196": "..."
  },
  "preview_url": null,
  "viewer_url": "https://teleport.varjo.com/captures/...",
  "share_url": "https://teleport.varjo.com/captures/...",
  "share_link": "https://teleport.varjo.com/share/...",
  "gif_url": "...",
  "video_url": "...",
  "share_video_url": "...",
  "is_public": false
}

⚠️ Only editable attributes will be applied. The example above shows renaming a capture.

Validation and Errors

When editing a capture, the API validates the request data. If validation fails (for example, invalid attribute types or missing required fields), the API returns a 422 Unprocessable Entity response:

Example 422 response:

{
  "detail": [
    {
      "loc": ["string", 0],
      "msg": "string",
      "type": "string"
    }
  ]
}

• loc indicates the location of the invalid field.
• msg contains a description of the validation error.
• type identifies the type of validation failure.

⚠️ Make sure all attributes conform to the expected types and constraints to avoid 422 errors.

---

3. Delete Capture

Remove a capture permanently. Once deleted, it cannot be recovered.

Endpoint:

DELETE /api/v1/captures/EID

Replace EID with the capture identifier (eid) obtained when creating the capture or listing captures.

Example curl request:

curl -X DELETE "https://teleport.varjo.com/api/v1/captures/EID" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example response:

The successful response will have the 204 No Content HTTP status code and will return nothing.

⚠️ Make sure you really intend to delete the capture - this action is irreversible.

---

Summary

Action	Method	Endpoint	Description
List captures	GET	/api/v1/captures	Retrieve all your uploaded captures
Edit capture	PUT	/api/v1/captures/{eid}	Update attributes (e.g., name)
Delete capture	DELETE	/api/v1/captures/{eid}	Permanently remove a capture

---

💡 Tip: Use the list captures endpoint to get the eid of a capture before attempting to edit or delete it.