Skip to main content
GET
Get a prompt by ID

Authorizations

x-api-key
string
header
required

API key issued for Interchange; reach out to Loti to obtain an API key.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Prompt found

Response when fetching a prompt by ID.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
createdAt
string<date-time>
required

ISO 8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required

ISO 8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
promptText
string | null
required

Original prompt text provided by the requester.

Minimum string length: 1
enhancedPromptText
string | null
required

Experimental: Prompt text after enhancement, if applied. This field may be removed in a future API version.

enhancedPromptStrictnessLevel
integer | null
required

Experimental: Strictness level applied by the enhancer. This field may be removed in a future API version.

Required range: 1 <= x <= 5
providerId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
generatedContentType
enum<string>
required

Type of content being generated.

Available options:
image,
video,
audio_voice
licenseType
enum<string>
required

Type of license for content usage: personal (non-commercial), limited_commercial (small business/limited reach), or major_commercial (large campaigns, requires approval).

Available options:
personal,
limited_commercial,
major_commercial
pricingUnit
enum<string>
required

Unit of generated content, for billing purposes.

Available options:
word_count,
asset_count,
length_seconds
estimatedQuantity
integer
required

Provider-supplied estimate of how many pricing units will be generated.

Required range: 0 < x <= 86400
estimatedTotalPriceMicros
integer | null
required

Estimated total price in micros (millionths of a USD); null when authorization is denied.

Required range: 0 <= x <= 9007199254740991
authorizationResult
enum<string>
required

Outcome of prompt authorization: 'authorized' (prompt approved, proceed to generate), 'not_authorized' (prompt denied, see authorizationDeniedCode and authorizationDeniedReason), 'failed' (authorization could not be completed), or 'pending' (still processing).

Available options:
pending,
authorized,
not_authorized,
failed
authorizationDeniedCode
enum<string> | null
required

If prompt authorization was denied, contains a machine-readable code describing the denial reason.

Available options:
RULES_VIOLATION,
RULES_NOT_CONFIGURED,
RATE_CARD_NOT_CONFIGURED,
INCOMPLETE_PRICING,
NO_IDENTITIES,
NO_TEXT,
IDENTITIES_NOT_FOUND,
MAJOR_COMMERCIAL_NOT_SUPPORTED,
NO_AGREEMENT_FOR_LICENSE_TYPE
authorizationDeniedReason
string | null
required

If prompt authorization was denied, contains a human-readable explanation of the reason for denial.