Skip to main content
POST
/
api
/
v1
/
assets
cURL
curl --request POST \
  --url http://localhost:3001/api/v1/assets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filename": "<string>",
  "s3Key": "<string>",
  "contentType": "<string>",
  "size": 123,
  "assetType": "content-image",
  "websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "asset": {
    "id": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assetType": "<string>",
    "filename": "<string>",
    "s3Key": "<string>",
    "contentType": "<string>",
    "size": 123,
    "url": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "altText": "<string>",
    "tags": [
      "<string>"
    ],
    "width": 123,
    "height": 123,
    "websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "website": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Body

application/json
filename
string
required
Minimum string length: 1
s3Key
string
required
Minimum string length: 1
contentType
string
required
Minimum string length: 1
size
number
required
assetType
enum<string>
default:content-image
Available options:
content-image,
content-document,
lead-magnet
imageType
enum<string>

Category of image for use in email templates

Available options:
logo,
hero,
header,
product,
background,
icon,
other
websiteId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

success
boolean
required
asset
object
required