Skip to main content
GET
/
stories
/
{id}
Get a pull story
curl --request GET \
  --url https://pullstory.com/api/v1/stories/{id}
{
  "id": "brief_0123abcd4567ef89",
  "url": "https://pullstory.com/s/brief_0123abcd4567ef89",
  "cached": false,
  "message": "Another request is already generating this story",
  "estimated_seconds": 90,
  "duration_seconds": 142,
  "scenes": 8,
  "title": "How auth works in this codebase",
  "error": "Story generation failed. Retry with a smaller brief."
}

Path Parameters

​
id
string
required
Pattern: ^brief_[a-f0-9]{16}$
Example:

"brief_0123abcd4567ef89"

Response

Pull story details

​
id
string
Example:

"brief_0123abcd4567ef89"

​
status
enum<string>
Available options:
generating,
ready,
failed
​
url
string
Example:

"https://pullstory.com/s/brief_0123abcd4567ef89"

​
cached
boolean
Example:

false

​
message
string
Example:

"Another request is already generating this story"

​
estimated_seconds
integer | null
Example:

90

​
duration_seconds
integer | null
Example:

142

​
scenes
integer | null
Example:

8

​
title
string
Example:

"How auth works in this codebase"

​
error
string | null
Example:

"Story generation failed. Retry with a smaller brief."