# Vimmerse Get Story Detail

> Vimmerse Get Story Detail is a paid API for AI agents from agents.vimmerse.net, paid per call via MPP, price unknown, status unknown (last checked 2026-10-31).

Retrieves a story job by ID, returning its current status, progress percentage, and final video URL when complete.

## Facts

- Endpoint: GET https://agents.vimmerse.net/v2/story/{story_id}?utm_source=zero.xyz
- Price: price unknown
- Payment: MPP
- Status: unknown
- Last checked: 2026-10-31
- Activations on Zero: 0
- Provider: agents.vimmerse.net
- Website: https://agents.vimmerse.net
- Canonical page: https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-get-story-detail-87c27425
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_VoTsv5_fI0ADrnjD28x5A

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability agents-vimmerse-net-vimmerse-get-story-detail-87c27425
```

Example prompt: Can you check the status of my Vimmerse story with ID abc123-def456-ghi789 and let me know if the video is ready yet?

## When to prefer this

Use this endpoint after creating a story job (via the Create Story endpoint) to track its asynchronous progress and retrieve the final video URL. This is the canonical polling endpoint for story-level multi-scene video jobs on Vimmerse, as opposed to the Get Media endpoint which tracks individual media objects. Prefer this when you need the aggregated story output (combined video_url) and metadata about all media items in the story.

## Known failure modes

- Story ID not found — returns 404 if the ID does not exist or belongs to another account
- Story still processing — status will be 'pending' or 'processing' and video_url will be null; agent must poll again
- Authentication failure — missing or invalid X-Api-Key header returns 401/403
- Story failed — status may be 'failed' with no video_url populated
- Network timeout — the polling request itself times out before receiving a response

## How this service works

Retrieves a story by ID. Use this to poll until `status` is `success` and then read `video_url`.

### Example: Get Story (Python)

```python
import requests

BASE_URL = "https://api.vimmerse.net"
API_KEY = "YOUR_API_KEY"
STORY_ID = "your-story-id-here"

url = f"{BASE_URL}/v2/story/{STORY_ID}"
headers = {"X-Api-Key": API_KEY}

response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
result = response.json()
print(f"Story ID: {result['id']}, Status: {result['status']}, Progress: {result.get('progress_percentage', 0)}%")
if result.get("status") == "success" and result.get("video_url"):
    print(f"Video URL: {result['video_url']}")
```

## Output

A JSON object containing the story's ID, title, idea/concept, current status (e.g. 'pending', 'processing', 'success', 'failed'), progress percentage, the final video_url (null until complete), and an array of all_medias with individual media item details including prompts, generated video URLs, resolution, video tool used, and timestamps.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "required": [
  "story_id"
 ],
 "properties": {
  "story_id": {
   "type": "string",
   "title": "Story ID",
   "examples": [
    "abc123-def456-ghi789"
   ],
   "description": "Unique identifier of the story to retrieve"
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "type": "object",
 "title": "CustomerStoryResponse",
 "properties": {
  "id": {
   "type": "string",
   "title": "ID",
   "default": ""
  },
  "idea": {
   "type": "string",
   "title": "Idea",
   "default": "",
   "description": "Idea of the story"
  },
  "title": {
   "type": "string",
   "title": "Title",
   "default": ""
  },
  "status": {
   "type": "string",
   "title": "Status",
   "default": ""
  },
  "video_url": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "Video URL"
  },
  "all_medias": {
   "type": "array",
   "items": {
    "type": "object",
    "title": "CustomerMediaResponse",
    "properties": {
     "id": {
      "type": "string",
      "title": "Id",
      "default": ""
     },
     "title": {
      "type": "string",
      "title": "Title",
      "default": ""
     },
     "prompt": {
      "type": "string",
      "title": "Prompt",
      "default": ""
     },
     "result": {
      "type": "array",
      "items": {},
      "title": "Generated Video URLs",
      "default": []
     },
     "version": {
      "type": "string",
      "title": "Version",
      "default": "3"
     },
     "quantity": {
      "type": "integer",
      "title": "Quantity",
      "default": 1,
      "maximum": 4,
      "minimum": 1,
      "description": "Number of generated outputs."
     },
     "created_at": {
      "type": "string",
      "title": "Created At",
      "default": ""
     },
     "resolution": {
      "type": "array",
      "items": {},
      "title": "Resolution",
      "default": []
     },
     "updated_at": {
      "type": "string",
      "title": "Updated At",
      "default": ""
     },
     "video_tool": {
      "enum": [
       "Auto",
       "AutoT3",
       "AutoT1",
       "HappyHorse",
       "Grok",
       "KlingAI",
       "KlingT3",
       "KlingPro",
       "GoogleOmni",
       "VeoLite",
       "VeoFast",
       "Veo",
       "RunwayML",
       "MinimaxHailuo",
       "MinimaxTurbo",
       "Seedance",
       "SeedanceFast",
       "SeedanceT6",
       "Pixverse",
       "PixverseT3",
       "Hunyuan",
       "Vidu",
       "PVideo",
       "StaticMotion",
       "Wan",
       "TryOnVideo"
      ],
      "type": "string",
      "title": "Video Tool",
      "default": "Auto",
      "description": "Motion/generation tool option (same as create media)."
     },
     "customer_id": {
      "type": "string",
      "title": "Customer ID",
      "default": ""
     },
     "descr
… (truncated)
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-get-story-detail-87c27425/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from agents.vimmerse.net](https://www.zero.xyz/host/agents.vimmerse.net/llms.txt)