Get a presigned URL to upload company logo

curl --request POST \
  --url https://api-dev.narrative.io/admin/companies/logo-upload-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_name": "logo.png"
}
'

{
  "upload_url": "https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221206T163031Z&X-Amz-SignedHeaders=host",
  "permanent_url": "https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png",
  "expiry": "2022-12-06T17:00:31.098Z",
  "content_type": "image/png"
}

Companies

Get a presigned URL to upload company logo

Sending a file to Narrative is a two step process. This endpoint allows you to request an upload_url which can be used in a PUT request to upload the file. For example, once you have received an upload_url you could use it as follows:

curl -v --upload-file logo.png {upload_url}

The generated upload_url is only valid for 30 minutes after issuance.

Response also contains permanent_url, expiry, and content_type. permanent_url should be used as long-term reference. content_type should be used as Content-Type header since it is part of URL signature.

POST

admin

companies

logo-upload-url

Get a presigned URL to upload company logo

curl --request POST \
  --url https://api-dev.narrative.io/admin/companies/logo-upload-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_name": "logo.png"
}
'

{
  "upload_url": "https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221206T163031Z&X-Amz-SignedHeaders=host",
  "permanent_url": "https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png",
  "expiry": "2022-12-06T17:00:31.098Z",
  "content_type": "image/png"
}

Body

application/json

Name of the image that you want to upload.

image_name

string

Example:

"logo.png"

Response

List of companies

Presigned AWS URL, permanent URL and expiration.

upload_url

string

Example:

"https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221206T163031Z&X-Amz-SignedHeaders=host"

permanent_url

string

Example:

"https://fake-test-cdn.s3.amazonaws.com/images/company-logos/local/companyId_1__56ff5f47-7660-4c0c-807e-af2c8a3e666b_logo.png"

expiry

string

Example:

"2022-12-06T17:00:31.098Z"

content_type

string

Example:

"image/png"

Lists Company Domains Get a company

⌘I