How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BLNG Journey API

REST API behind the BLNG Design application that manages design and shopping journeys, the prompts submitted against them, uploaded and generated image assets, chat prompts, design plans, and 3D model generation and conversion. Supports free-text search over journeys, cursor pagination via nextPageKey, and conditional GETs with ETag / If-None-Match. Authenticated with an AWS Cognito access or id token as a bearer JWT.

This API exposes 33 operations across 28 paths, organized into 4 resource areas, and defines 48 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, /v2.

33 operations 28 paths 48 schemas 2 DELETE17 GET13 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://journeys.blng.ai/v2
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
4

Authentication & Security 2

BLNG Journey API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It supports OAuth 2.0 (cognitoUserAuth) using the implicit flow, exposing 4 scopes.

  • bearerAuth — Use your Cognito "accesstoken" or "idtoken" obtained from AWS Cognito Hosted UI or CLI. Click "Authorize" and paste the token.
  • cognitoUserAuth — Cognito authorization code flow for users

Paths & Operations 33

Across 28 paths, the API surfaces 33 operations — 2 DELETE, 17 GET, 13 POST, 1 PUT. They span 4 resource areas: Journeys, Prompts, Design Journey, Chat Prompts. Each is listed below with its method, path, parameters, and response codes.

Journeys 8
GET
/journeys
Retrieve journeys or search for journeys based on criteria
getJourneys 7 params → 200400
POST
/journeys
Start a new journey
startNewJourney body → 201400
GET
/journeys/versions
Retrieve journeys by date since a specified timestamp
getJourneysByDate 2 params → 200400
POST
/journeys/restore
Restore multiple soft-deleted journeys in a single request
restoreJourneysBulk body → 200400
GET
/journeys/{journeyId}
Retrieve a specific journey
getJourney 2 params → 200304404
DELETE
/journeys/{journeyId}
Delete a specific journey
deleteJourney 1 param → 204403404
POST
/journeys/{journeyId}/restore
Restore a soft-deleted journey
restoreJourney 1 param → 200403404
PUT
/design/journeys/{journeyId}
Update a specific journey
updateJourney 1 param body → 200204400404
Prompts 4
GET
/journeys/{journeyId}/prompts
Retrieve paginated prompts for a specific journey, sorted from newest to oldest.
getPromptsForJourney 5 params → 200304400404
GET
/journeys/{journeyId}/prompts/{promptId}
Retrieve a single prompt by its unique identifier
getPromptById 3 params → 200400404
POST
/journeys/{journeyId}/prompts/{promptId}/cancel-processing
Cancel design-v3 prompt processing before a plan exists
cancelPromptProcessingBeforePlan 2 params → 200400404409
POST
/journeys/{journeyId}/prompts/{promptId}/plans/{planId}/cancel
Cancel a design plan for a prompt in a journey
cancelDesignPlanForPromptInJourney 3 params → 200422
Design Journey 19
GET
/design/assets
List assets for the authenticated user (newest first)
listAssetsForUser 2 params → 200
POST
/design/assets/upload
Create an upload slot and return a pre-signed URL
createAssetUploadUrl body → 201400
GET
/design/assets/{assetId}
Get asset metadata
getAsset 1 param → 200404
GET
/design/assets/{assetId}/download
Get a signed URL for downloading an asset
getAssetDownloadUrl 2 params → 200404
POST
/design/journeys/{journeyId}/images/uploaddeprecated
Generate an image and get a pre-signed URL for upload
generateImageUploadURL 1 param body → 201400404
GET
/design/journeys/{journeyId}/imagesdeprecated
Retrieve all images for a journey
getAllImagesForJourney 1 param → 200
GET
/design/journeys/{journeyId}/images/{imageId}deprecated
Retrieve metadata for a specified image
getImageMetadata 2 params → 200
DELETE
/design/journeys/{journeyId}/images/{imageId}deprecated
Remove a specific image from the journey
deleteImage 2 params → 204404
GET
/design/journeys/{journeyId}/images/{imageId}/downloaddeprecated
Generate a pre-signed URL for downloading an image
generateImageDownloadUrl 2 params → 200404
GET
/design/journeys/{journeyId}/models
List models for a journey (newest first)
listModelsForJourney 3 params → 200404
POST
/design/journeys/{journeyId}/models
Create a Model3D from an uploaded 3D asset
createModel3D 1 param body → 201400404
GET
/design/journeys/{journeyId}/models/{modelId}
Get a Model3D (slots and status)
getModel3D 2 params → 200404
POST
/design/journeys/{journeyId}/models/{modelId}/conversions
Re-submit conversions for any incomplete slots
resubmitModelConversions 2 params body → 202404
POST
/design/journeys/{journeyId}/generations
Start a model generation from a prompt image
startModelGeneration 1 param body → 202400401404422423
GET
/design/journeys/{journeyId}/generations
Get model generations for a journey (newest first)
listModelGenerations 4 params → 200404
GET
/design/journeys/{journeyId}/generations/{generationId}
Get a model generation for a prompt (request, state, response)
getModelGeneration 2 params → 200404
GET
/design/journeys/{journeyId}/plans/{planId}
Get a design plan for a journey
getDesignPlanForJourney 3 params → 200304404
GET
/design/journeys/{journeyId}/plans
List design plans for a journey (newest first)
listDesignPlansForJourney 5 params → 200304404
POST
/design/journeys/{journeyId}/image-ops
Submit an image operation (upscale, background removal, etc.)
1 param body → 202400401404
Chat Prompts 2
POST
/design/journeys/{journeyId}/chat-prompt
Submit a chat prompt request (design-v2)
submitChatPrompt 1 param body → 200400429
POST
/design/journeys/{journeyId}/chat-prompt-v3
Submit a chat prompt request (design-v3)
submitChatPromptV3 1 param body → 200400429

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Prompt (11 properties), JourneySpecifics (11 properties), Asset (10 properties), LegacyLayer (10 properties). Each schema is shown below with its type and property counts.

Journey
object
7 properties
JourneySpecifics
object
11 properties
Layer
ImageLayer
object
10 properties 6 required
ModelLayer
object
7 properties 6 required
LegacyLayer
object
Pre-discriminator layer shape. Accepted verbatim for back-compat; no server-side coercion.
10 properties 1 required
LayerImage
object
5 properties
LayerModel3D
object
3 properties 2 required
Transform3D
object
3 properties 3 required
Vector3
object
3 properties 3 required
Quaternion
object
4 properties 4 required
Image
object
This schema is deprecated and will be removed in the future. Please use the Asset schema instead.
5 properties 3 required
Prompt
object
11 properties 3 required
PromptRequest
object
4 properties 1 required
PromptRequestV3
object
6 properties 1 required
PromptResponse
object
2 properties
ChatPrompt
object
4 properties 4 required
ChatPromptRequest
ChatPromptRequestV3
ImageGenPromptDetails
object
4 properties
LassoMask
object
Details about a lasso mask selection.
2 properties 1 required
AssetDetails
object
3 properties
AssetReference
object
4 properties
ChatPromptResponse
Color
object
4 properties
Asset
object
10 properties 4 required
CreateModel3DRequest
object
1 property 1 required
Model3DSlot
object
4 properties 1 required
Model3D
object
Three-slot 3D model with conversion status per slot.
7 properties 7 required
SubmitModelConversionsRequest
object
1 property
ModelGenerationRequest
object
Request payload for generating a model from an image. Model generations first create a GLB, then the system automatically enqueues conversions to USD and USDZ.…
4 properties 1 required
ModelGenerationSuccessResponse
object
5 properties 5 required
ModelGenerationErrorResponse
object
4 properties 4 required
ModelGenerationResponse
Terminal payload for a model generation (success or error)
ModelGeneration
object
End-to-end pipeline - generation (GLB) → slot conversions (USD, USDZ) → ready
10 properties 6 required
DesignPlanItem
object
8 properties 8 required
DesignPlanStage
object
5 properties 5 required
DesignPlanGeneratedImages
object
1 property 1 required
ImageDimensions
object
2 properties
ImageOpsApiWorkflow
string
ImageOpsWorkflow
string
ImageLocation
object
2 properties 2 required
ImageOpsRequestBase
object
Common fields for POST /design/journeys/{journeyId}/image-ops (see ImageOpsRequest oneOf).
7 properties 2 required
ImageOpsLayerRequest
ImageOpsPromptRequest
ImageOpsLegacyRequest
ImageOpsRequest
ImageOpsAcceptedResponse
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

blng-journey-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of BLNG Journey API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.