Sign Up(It's FREE and ALWAYS will be)
Log In
Together We Remember is a platform where you can create, share, and preserve meaningful memories.
This document outlines the v0 version of the Together We Remember API.
The API is free to use, but you must first create a user account and know your password to authenticate and access the endpoints.
use WebService::TogetherWeRemember;
my $twr = WebService::TogetherWeRemember->new();
my $api = $twr->login($email, $password);
my $timeline = $api->timeline_create({
name => "My First Timeline",
description => $markdown_text,
image => '/path/to/image.png',
related_links => [
{ label => "lnation", url => "https//lnation.org" }
],
passphrase => "123",
is_public => 1,
is_published => 0,
is_open => 0,
});
my $memory = $api->memory_create($timeline->{timeline}->{id}, {
title => "My First Memory",
content => $markdown_text,
date => time,
related_links => [
{ label => "lnation", url => "https//lnation.org" }
],
});
$api->memory_asset($timeline->{timeline}->{id}, $memory->{memory}->{id}, '/path/to/asset.mp4', 5 * 1024 * 1024);
$api->logout();LWP::UserAgent instance used for HTTP requests.
Base URL for the API.
my $response = $api->login($email, $password);This method sends a login request to the TogetherWeRemember API with the provided email and password. It returns the HTTP response.
POST /api/loginThis method sends a form data POST request to /api/login with the above parameters.
my $response = $api->logout();This method sends a logout request to the TogetherWeRemember API. It returns the HTTP response.
GET /api/logoutThis method sends a GET request to /api/logout.
my $response = $api->user_get($user_id);This method retrieves user information from the TogetherWeRemember API.
GET /api/user/get or GET /api/user/get/:useridmy $response = $api->user_update({
name => 'My Name',
bio => $markdown_bio,
profile_image => '/path/to/image.png'
});This method updates user information in the TogetherWeRemember API.
POST /api/user/updateThis method sends a form data POST request to /api/user/update with the provided user data.
my $response = $api->timelines_published($user_id, { page => 1, q => 'search text' });This method retrieves published timelines from the TogetherWeRemember API.
GET /api/timeline/published or GET /api/timeline/published/:useridThis method sends a GET request to /api/timeline/published with the provided parameters.
my $response = $api->timelines_mine({ page => 0, limit => 10 });This method retrieves the user's own timelines from the TogetherWeRemember API.
GET /api/timelines/mineThis method sends a GET request to /api/timelines/mine with the provided parameters.
my $response = $api->timelines_collab({ page => 0, limit => 10 });This method retrieves timelines where the user is a collaborator from the TogetherWeRemember API.
GET /api/timelines/collabThis method sends a GET request to /api/timelines/collab with the provided parameters.
my $response = $api->timelines_liked({ page => 0, limit => 10 });This method retrieves timelines that the user has liked from the TogetherWeRemember API.
GET /api/timelines/likedThis method sends a GET request to /api/timelines/liked with the provided parameters.
my $response = $api->timeline_passphrase($timeline_id, $passphrase);This method authenticates you to access a timeline that has a passphrase attached to it. You will not need to use the passphrase for your own timelines only for collaborative.
POST /api/timeline/passphraseThis method sends a form data POST request to /api/timeline/passphrase with the provided timeline ID and passphrase.
my $response = $api->timeline_get($timeline_id);This method retrieves a specific timeline from the TogetherWeRemember API.
GET /api/timeline/get/:timelineidThis method sends a GET request to /api/timeline/get/:timelineid with the provided timeline ID.
my $response = $api->timeline_create({
name => 'My Timeline',
description => 'A description of my timeline',
image => '/path/to/image.png',
related_links => [
{ url => 'https://lnation.org', label => 'LNATION' },
{ url => 'https://example.com', label => 'Example' }
],
passphrase => '123',
is_public => 1,
is_published => 0,
is_open => 0,
});This method creates a new timeline in the TogetherWeRemember API.
POST /api/timeline/createurl and a label.This method sends a form data POST request to /api/timeline/create with the provided timeline data.
my $response = $api->timeline_update({
id => '12345',
name => 'Updated Timeline Name',
description => 'Updated description of the timeline',
image => '/path/to/new_image.png',
related_links => [
{ url => 'https://lnation.org', label => 'LNATION' },
{ url => 'https://example.com', label => 'Example' }
],
passphrase => 'newpassphrase',
is_public => 1,
is_published => 1,
is_open => 1,
});This method updates an existing timeline in the TogetherWeRemember API.
POST /api/timeline/updateurl and a label.This method sends a form data POST request to /api/timeline/update with the provided timeline data.
my $response = $api->timeline_delete($timeline_id);This method deletes a timeline from the TogetherWeRemember API.
POST /api/timeline/delete/:timelineidThis method sends a POST request to /api/timeline/delete/:timelineid with the provided timeline ID.
my $response = $api->memory_list($timeline_id, {
page => 0,
limit => 10,
orderby => 'event_date',
orderdir => 'desc',
from => 1751026816, # Unix timestamp
to => 1751026920, # Unix timestamp
q => 'search text'
});This method retrieves a list of memories (timeline items) for a given timeline from the TogetherWeRemember API.
GET /api/timeline/item/listThis method sends a GET request to /api/timeline/item/list with the provided parameters.
my $response = $api->memory_get($timeline_id, $memory_id);This method retrieves a specific memory (timeline item) from the TogetherWeRemember API.
GET /api/timeline/item/getThis method sends a GET request to /api/timeline/item/get with the provided timeline ID and memory ID.
my $response = $api->memory_create($timeline_id, {
title => 'My Memory Title',
content => 'A description of my memory',
date => epoch,
related_links => [
{ url => 'https://lnation.org', label => 'LNATION' },
{ url => 'https://example.com', label => 'Example' }
],
});This method creates a new memory (timeline item) in the TogetherWeRemember API.
POST /api/timeline/item/saveurl and a label.This method sends a form data POST request to /api/timeline/item/save with the provided memory data.
my $response = $api->memory_update($timeline_id, $memory_id, {
title => 'Updated Memory Title',
content => 'Updated description of my memory',
date => epoch,
existing_image_ids => [ 10, 15 ],
related_links => [
{ url => 'https://lnation.org', label => 'LNATION' },
{ url => 'https://example.com', label => 'Example' }
],
});This method updates an existing memory (timeline item) in the TogetherWeRemember API.
POST /api/timeline/item/saveurl and a label.This method sends a form data POST request to /api/timeline/item/save with the provided memory data.
my $response = $api->memory_asset($timeline_id, $memory_id, '/path/to/asset.mp4', 5 * 1024 * 1024);This method uploads an asset (file) to a specific memory in the TogetherWeRemember API.
POST /api/timeline/item/assetThis method uploads the specified file in chunks (default 5MB each) to /api/timeline/item/asset for the given timeline and memory. Each chunk is sent as a separate POST request with multipart form data.
my $response = $api->memory_delete($timeline_id, $memory_id);This method deletes a specific memory (timeline item) from the TogetherWeRemember API.
POST /api/timeline/item/deleteThis method sends a POST request to /api/timeline/item/delete with the provided timeline ID and memory ID.
Reset Password
Markdown Guide
# Heading 1 ## Heading 2 ### Heading 3Emphasis
*Italic* **Bold** ~~Strikethrough~~Lists
- Unordered item * Unordered item 1. Ordered item 2. Ordered itemTable
| Header 1 | Header 2 | |----------|----------| | Cell 1 | Cell 2 | | Cell 1 | Cell 2 |