Create a story
curl --request POST \
--url https://apix.us.amity.co/api/v4/stories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"text": "example text",
"fileId": "<string>",
"imageDisplayMode": "fit"
},
"targetType": "community",
"targetId": "public_community_id",
"referenceId": "<string>",
"items": [
{
"type": "hyperlink",
"data": {
"url": "https://www.google.com",
"customText": "Google"
}
}
],
"metadata": {
"anything": "you want"
}
}
'import requests
url = "https://apix.us.amity.co/api/v4/stories"
payload = {
"data": {
"text": "example text",
"fileId": "<string>",
"imageDisplayMode": "fit"
},
"targetType": "community",
"targetId": "public_community_id",
"referenceId": "<string>",
"items": [
{
"type": "hyperlink",
"data": {
"url": "https://www.google.com",
"customText": "Google"
}
}
],
"metadata": { "anything": "you want" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {text: 'example text', fileId: '<string>', imageDisplayMode: 'fit'},
targetType: 'community',
targetId: 'public_community_id',
referenceId: '<string>',
items: [
{type: 'hyperlink', data: {url: 'https://www.google.com', customText: 'Google'}}
],
metadata: {anything: 'you want'}
})
};
fetch('https://apix.us.amity.co/api/v4/stories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v4/stories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'text' => 'example text',
'fileId' => '<string>',
'imageDisplayMode' => 'fit'
],
'targetType' => 'community',
'targetId' => 'public_community_id',
'referenceId' => '<string>',
'items' => [
[
'type' => 'hyperlink',
'data' => [
'url' => 'https://www.google.com',
'customText' => 'Google'
]
]
],
'metadata' => [
'anything' => 'you want'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v4/stories"
payload := strings.NewReader("{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v4/stories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v4/stories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stories": [
{
"storyId": "<string>",
"data": {
"text": "<string>",
"fileId": "<string>",
"imageDisplayMode": "fit",
"thumbnailFileId": "<string>",
"videoFileId": {
"original": "<string>",
"low": "<string>",
"medium": "<string>",
"high": "<string>"
}
},
"path": "<string>",
"creatorId": "<string>",
"creatorPublicId": "<string>",
"targetId": "<string>",
"targetPublicId": "<string>",
"items": [],
"metadata": {},
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"reactions": {
"like": 1
},
"reactionsCount": 1,
"myReactions": [
"like"
],
"commentsCount": 1,
"isDeleted": false,
"hasFlaggedComment": false,
"mentionedUsers": [
{
"userIds": [
"<string>"
],
"userPublicIds": [
"<string>"
]
}
],
"impression": 123,
"reach": 123,
"referenceId": "<string>"
}
],
"comments": [
{
"commentId": "<string>",
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"parentId": "<string>",
"rootId": "<string>",
"referenceId": "<string>",
"dataType": "<string>",
"dataTypes": [],
"data": {},
"metadata": {},
"childrenNumber": 123,
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"reactions": {
"like": 1
},
"reactionsCount": 1,
"myReactions": [
"like"
],
"isDeleted": false,
"editedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"children": [
"<string>"
],
"segmentNumber": 1,
"mentionees": [
{
"type": "user",
"userIds": [
"<string>"
],
"userPublicIds": [
"<string>"
],
"userInternalIds": [
"<string>"
]
}
],
"attachments": [
{
"fileId": "<string>"
}
],
"targetId": "<string>"
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"users": [
{
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"path": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"isDeleted": true
}
],
"roles": [
{
"roleId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"isDeleted": false,
"displayName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"communities": [
{
"communityId": "<string>",
"channelId": "<string>",
"displayName": "<string>",
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false
}
],
"communityUsers": [
{
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"channelId": "<string>",
"communityId": "<string>",
"notMemberReason": "<string>",
"isBanned": false,
"lastActivity": "2023-11-07T05:31:56Z",
"roles": [
"<string>"
],
"permissions": [],
"lastJoin": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"categories": [
{
"categoryId": "<string>",
"name": "<string>",
"metadata": {},
"avatarFileId": "<string>",
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Story
Create a story
Create a story
POST
/
api
/
v4
/
stories
Create a story
curl --request POST \
--url https://apix.us.amity.co/api/v4/stories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"text": "example text",
"fileId": "<string>",
"imageDisplayMode": "fit"
},
"targetType": "community",
"targetId": "public_community_id",
"referenceId": "<string>",
"items": [
{
"type": "hyperlink",
"data": {
"url": "https://www.google.com",
"customText": "Google"
}
}
],
"metadata": {
"anything": "you want"
}
}
'import requests
url = "https://apix.us.amity.co/api/v4/stories"
payload = {
"data": {
"text": "example text",
"fileId": "<string>",
"imageDisplayMode": "fit"
},
"targetType": "community",
"targetId": "public_community_id",
"referenceId": "<string>",
"items": [
{
"type": "hyperlink",
"data": {
"url": "https://www.google.com",
"customText": "Google"
}
}
],
"metadata": { "anything": "you want" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {text: 'example text', fileId: '<string>', imageDisplayMode: 'fit'},
targetType: 'community',
targetId: 'public_community_id',
referenceId: '<string>',
items: [
{type: 'hyperlink', data: {url: 'https://www.google.com', customText: 'Google'}}
],
metadata: {anything: 'you want'}
})
};
fetch('https://apix.us.amity.co/api/v4/stories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v4/stories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'text' => 'example text',
'fileId' => '<string>',
'imageDisplayMode' => 'fit'
],
'targetType' => 'community',
'targetId' => 'public_community_id',
'referenceId' => '<string>',
'items' => [
[
'type' => 'hyperlink',
'data' => [
'url' => 'https://www.google.com',
'customText' => 'Google'
]
]
],
'metadata' => [
'anything' => 'you want'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v4/stories"
payload := strings.NewReader("{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v4/stories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v4/stories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"text\": \"example text\",\n \"fileId\": \"<string>\",\n \"imageDisplayMode\": \"fit\"\n },\n \"targetType\": \"community\",\n \"targetId\": \"public_community_id\",\n \"referenceId\": \"<string>\",\n \"items\": [\n {\n \"type\": \"hyperlink\",\n \"data\": {\n \"url\": \"https://www.google.com\",\n \"customText\": \"Google\"\n }\n }\n ],\n \"metadata\": {\n \"anything\": \"you want\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stories": [
{
"storyId": "<string>",
"data": {
"text": "<string>",
"fileId": "<string>",
"imageDisplayMode": "fit",
"thumbnailFileId": "<string>",
"videoFileId": {
"original": "<string>",
"low": "<string>",
"medium": "<string>",
"high": "<string>"
}
},
"path": "<string>",
"creatorId": "<string>",
"creatorPublicId": "<string>",
"targetId": "<string>",
"targetPublicId": "<string>",
"items": [],
"metadata": {},
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"reactions": {
"like": 1
},
"reactionsCount": 1,
"myReactions": [
"like"
],
"commentsCount": 1,
"isDeleted": false,
"hasFlaggedComment": false,
"mentionedUsers": [
{
"userIds": [
"<string>"
],
"userPublicIds": [
"<string>"
]
}
],
"impression": 123,
"reach": 123,
"referenceId": "<string>"
}
],
"comments": [
{
"commentId": "<string>",
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"parentId": "<string>",
"rootId": "<string>",
"referenceId": "<string>",
"dataType": "<string>",
"dataTypes": [],
"data": {},
"metadata": {},
"childrenNumber": 123,
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"reactions": {
"like": 1
},
"reactionsCount": 1,
"myReactions": [
"like"
],
"isDeleted": false,
"editedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"children": [
"<string>"
],
"segmentNumber": 1,
"mentionees": [
{
"type": "user",
"userIds": [
"<string>"
],
"userPublicIds": [
"<string>"
],
"userInternalIds": [
"<string>"
]
}
],
"attachments": [
{
"fileId": "<string>"
}
],
"targetId": "<string>"
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"users": [
{
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"path": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"isDeleted": true
}
],
"roles": [
{
"roleId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"isDeleted": false,
"displayName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"communities": [
{
"communityId": "<string>",
"channelId": "<string>",
"displayName": "<string>",
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"avatarFileId": "<string>",
"description": "<string>",
"isOfficial": true,
"isPublic": true,
"onlyAdminCanPost": true,
"tags": [
"<string>"
],
"metadata": {},
"postsCount": 123,
"membersCount": 123,
"isJoined": true,
"categoryIds": [
"<string>"
],
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hasFlaggedComment": false,
"hasFlaggedPost": false,
"needApprovalOnPostCreation": false,
"moderatorMemberCount": 123,
"allowCommentInStory": true,
"isDiscoverable": false,
"requiresJoinApproval": false
}
],
"communityUsers": [
{
"userId": "<string>",
"userPublicId": "<string>",
"userInternalId": "<string>",
"channelId": "<string>",
"communityId": "<string>",
"notMemberReason": "<string>",
"isBanned": false,
"lastActivity": "2023-11-07T05:31:56Z",
"roles": [
"<string>"
],
"permissions": [],
"lastJoin": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"categories": [
{
"categoryId": "<string>",
"name": "<string>",
"metadata": {},
"avatarFileId": "<string>",
"isDeleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Main data contained in the story, required only 1 field depends on dataType. The size of this object must be less than 10 KB.
Show child attributes
Show child attributes
Available options:
text, image, video where to create story to. currently limited to community only
Available options:
community Resource public id depends on target type (ex. target type is community, target id will be community public id)
Example:
"public_community_id"
the id used for reference when optimistically create the story
List of items contained in story. Currently only support hyperlink item. Only one hyperlink item is allowed per story.
Maximum array length:
10Show child attributes
Show child attributes
Metadata of the story. The size of this object must be less than 5 KB
Example:
{ "anything": "you want" }
Response
Create Result
Create story response payload
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I