Stories

Get a story

Retrieve a single story.

get/api/v1/stories/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/stories/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The ID of the story to retrieve

Query parameters

story_mode'TEST' | 'LIVE'

The mode of the story to retrieve

draft_idinteger

The ID of the draft to retrieve

include_live_activityboolean

When set to true, includes live activity metrics like pending_action_runs_count, concurrent_runs_count, and tokens_used_percentage

Response

Successful response

idinteger

Story ID

namestring

Story name

user_idinteger

ID of the story creator

descriptionstring nullable

User-defined description of the story

keep_events_forinteger

Event retention period in seconds

disabledboolean

Whether the story is disabled

priorityboolean

Whether the story is high priority

send_to_story_enabledboolean

Whether Send to Story is enabled

send_to_story_access_sourcestring

Where Send to Story can be used (STS, STS_AND_WORKBENCH, WORKBENCH, OFF)

send_to_story_accessstring nullable

Who is allowed to send to this story (TEAM, GLOBAL, SPECIFIC_TEAMS)

send_to_story_referring_story_idsinteger[]

IDs of stories that call this Send to Story enabled story. Only present when send_to_story_enabled is true

shared_team_slugsstring[]

Slugs of teams that can send to this story when send_to_story_access is SPECIFIC_TEAMS, otherwise empty

send_to_story_timeout_enabledboolean

Whether a timeout is enabled for Send to Story runs

send_to_story_timeout_duration_secondsinteger nullable

Maximum time in seconds a Send to Story run may take before timing out. Only takes effect when send_to_story_timeout_enabled is true. null if no duration has been set

send_to_story_skill_use_requires_confirmationboolean

Whether Workbench should ask for confirmation before running this story

entry_agent_idinteger nullable

ID of the entry action for this story

exit_agentsobject[]

Objects describing exit actions for this story

team_idinteger

ID of the team to which the story belongs

tagsstring[]

Tags used to classify the story

guidstring

Unique identifier of the story

slugstring

Underscored representation of the story name

created_atstring

ISO 8601 timestamp of when the story was created

updated_atstring

ISO 8601 timestamp of when the story row was last updated

edited_atstring

ISO 8601 timestamp of when the story was last logically updated

modestring

Mode of the story (LIVE or TEST)

folder_idinteger nullable

ID of the folder to which the story belongs

publishedboolean

Whether the story is published

change_control_enabledboolean

Whether change control is enabled

lockedboolean

Whether the story is locked to changes

ownersinteger[]

IDs of users listed as owners on the story

monitor_failuresboolean

Whether monitor failures is enabled on all actions in the story

actions_with_monitoringinteger[]

IDs of actions with monitoring enabled

recipientsobject[]

Monitoring recipients for the story

Changes

No recorded changes to this operation across all 1 revision of this API.