Blazor Diffusion

<back to all web services

QueryCreatives

Creatives
QueryCreatives Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
CreatedByquerystringNo
OwnerIdqueryint?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Creative Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserPromptformstringYes
PromptformstringYes
ImagesformintNo
WidthformintNo
HeightformintNo
StepsformintNo
CuratedArtifactIdformint?No
PrimaryArtifactIdformint?No
ArtistNamesformList<string>Yes
ModifierNamesformList<string>Yes
ArtistsformList<CreativeArtist>Yes
ModifiersformList<CreativeModifier>Yes
ArtifactsformList<Artifact>Yes
ErrorformstringNo
OwnerIdformint?No
OwnerRefformstringNo
KeyformstringNo
CuratedformboolNo
Ratingformint?No
PrivateformboolNo
ScoreformintNo
RankformintNo
RefIdformstringYes
RequestIdformstringYes
EngineIdformstringYes
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
CreativeArtist Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreativeIdformintNo
ArtistIdformintNo
ArtistformArtistYes
Artist Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
LastNameformstringYes
YearDiedformint?No
TypeformList<string>No
ScoreformintNo
RankformintNo
CreativeModifier Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreativeIdformintNo
ModifierIdformintNo
ModifierformModifierYes
Modifier Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
CategoryformstringYes
DescriptionformstringNo
ScoreformintNo
RankformintNo
Artifact Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreativeIdformintNo
FileNameformstringYes
FilePathformstringYes
ContentTypeformstringYes
ContentLengthformlongNo
WidthformintNo
HeightformintNo
SeedformulongNo
PromptformstringYes
Nsfwformbool?No
AverageHashformlong?No
PerceptualHashformlong?No
DifferenceHashformlong?No
BackgroundformstringNo
LqipformstringNo
QualityformintNo
LikesCountformintNo
AlbumsCountformintNo
DownloadsCountformintNo
SearchCountformintNo
TemporalScoreformintNo
ScoreformintNo
RankformintNo
RefIdformstringYes
VersionsformDictionary<string, string>Yes
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<ArtifactResult>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
ArtifactResult Parameters:
NameParameterData TypeRequiredDescription
UserPromptformstringYes
ArtistNamesformList<string>Yes
ModifierNamesformList<string>Yes
PrimaryArtifactIdformint?No
OwnerRefformstringYes
Similarityformdouble?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/QueryCreatives HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	createdBy: String,
	ownerId: 0,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			userPrompt: String,
			prompt: String,
			images: 0,
			width: 0,
			height: 0,
			steps: 0,
			curatedArtifactId: 0,
			primaryArtifactId: 0,
			artistNames: 
			[
				String
			],
			modifierNames: 
			[
				String
			],
			artists: 
			[
				{
					id: 0,
					creativeId: 0,
					artistId: 0,
					artist: 
					{
						id: 0,
						firstName: String,
						lastName: String,
						yearDied: 0,
						type: 
						[
							String
						],
						score: 0,
						rank: 0,
						createdDate: 0001-01-01,
						createdBy: String,
						modifiedDate: 0001-01-01,
						modifiedBy: String,
						deletedDate: 0001-01-01,
						deletedBy: String
					}
				}
			],
			modifiers: 
			[
				{
					id: 0,
					creativeId: 0,
					modifierId: 0,
					modifier: 
					{
						id: 0,
						name: String,
						category: String,
						description: String,
						score: 0,
						rank: 0,
						createdDate: 0001-01-01,
						createdBy: String,
						modifiedDate: 0001-01-01,
						modifiedBy: String,
						deletedDate: 0001-01-01,
						deletedBy: String
					}
				}
			],
			artifacts: 
			[
				{
					id: 0,
					creativeId: 0,
					fileName: String,
					filePath: String,
					contentType: String,
					contentLength: 0,
					width: 0,
					height: 0,
					seed: 0,
					prompt: String,
					nsfw: False,
					averageHash: 0,
					perceptualHash: 0,
					differenceHash: 0,
					background: String,
					lqip: String,
					quality: 0,
					likesCount: 0,
					albumsCount: 0,
					downloadsCount: 0,
					searchCount: 0,
					temporalScore: 0,
					score: 0,
					rank: 0,
					refId: String,
					versions: 
					{
						String: String
					},
					createdDate: 0001-01-01,
					createdBy: String,
					modifiedDate: 0001-01-01,
					modifiedBy: String,
					deletedDate: 0001-01-01,
					deletedBy: String
				}
			],
			error: String,
			ownerId: 0,
			ownerRef: String,
			key: String,
			curated: False,
			rating: 0,
			private: False,
			score: 0,
			rank: 0,
			refId: String,
			requestId: String,
			engineId: String,
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}