Indox Auth API - OSLLM AI
AuthResponse
Response model for authentication containing token and user info.
required
required
required
required
required
required
required
required
object · required
object · required
Default: Authentication successful
Default: Bearer
LoginRequest
Request model for user login. Supports traditional username/password/email, Google OAuth, and Apple Sign-In authentication.
For Google OAuth authentication:
- Tokens can be provided in request body (legacy method)
- Tokens can be read from HTTPOnly cookies (recommended - set automatically after OAuth callback)
- If tokens are in cookies, no need to include them in request body
For Apple Sign-In authentication:
- Tokens can be provided in request body (legacy method)
- Tokens can be read from HTTPOnly cookies (recommended - set automatically after OAuth callback)
- If tokens are in cookies, no need to include them in request body
Username or email address for traditional login
writeOnly
Email address for traditional login (alternative to username field)
Password for traditional login
writeOnly
Google OAuth access token (from body or cookies)
writeOnly
Google OAuth ID token/JWT (from body or cookies)
writeOnly
Apple identity token/JWT (from body or cookies)
remember_meRemember user session for extended period
Default: true
RegisterRequest
Request model for user registration.
usernameemailpasswordterms_acceptedDefault:
Default:
PasswordChangeRequest
Request model for changing password.
passwordNew password to set
ChangePasswordRequest
Request model for changing password with current password verification.
current_passwordCurrent password for verification
new_passwordNew password to set
AccountDeleteResponse
Response model for account deletion.
messagedeleted_atuser_idusernameemaildata_preservedDefault: true
can_restoreDefault: true
AccountDeleteRequest
Request model for soft deleting user account.
passwordconfirmation_textDefault: DELETE MY ACCOUNT
TokenVerifyResponse
Response model for token verification.
validmessageDeviceInfo
Device information extracted from user agent.
osbrowserdevice_typeraw_user_agentSessionInfo
Session information for device management.
idsession_idobject · required
Device information extracted from user agent.
last_active_atcreated_atexpires_atis_activeAPIKeyListResponse
List response for user's API keys.
max_keysactive_counttotal_keysobject · required
Aggregated usage stats for all of a user's API keys.
object[] · required
APIKeyResponse
Serialized API key metadata (without the raw key).
idnamepermissionsis_activecreated_atrate_limit_per_hourip_whitelistmasked_keyNon-sensitive preview of the API key so the user can recognize it later.
Default:
total_requestsTotal requests ever made with this API key.
Default: 0
requests_last_hourNumber of requests made with this key in the last hour.
Default: 0
rate_limit_used_last_hourRequests counted toward the current hourly rate limit window.
Default: 0
rate_limit_remainingRemaining requests in the current hourly rate limit window.
Default: 0
rate_limit_usage_percentPercent of the hourly rate limit consumed (0-100).
Default: 0
APIKeyUsageSummary
Aggregated usage stats for all of a user's API keys.
total_requests_last_hourCombined requests across all API keys in the last hour.
Default: 0
total_requests_last_30_daysCombined requests across all API keys in the last 30 days.
Default: 0
total_requestsCombined lifetime requests across all API keys.
Default: 0
rate_limit_used_last_hourRequests counted toward the aggregate hourly rate limits.
Default: 0
rate_limit_per_hourSum of hourly rate limits for all active API keys.
Default: 0
rate_limit_remainingRemaining aggregate requests before hitting the hourly cap.
Default: 0
rate_limit_usage_percentPercent of aggregate hourly rate limit consumed (0-100).
Default: 0
APIKeyCreateResponse
Response containing metadata and the one-time raw API key.
idnamepermissionsis_activecreated_atrate_limit_per_hourraw_keyPlaintext API key. Shown exactly once on creation.
ip_whitelistmasked_keyNon-sensitive preview of the API key so the user can recognize it later.
Default:
total_requestsTotal requests ever made with this API key.
Default: 0
requests_last_hourNumber of requests made with this key in the last hour.
Default: 0
rate_limit_used_last_hourRequests counted toward the current hourly rate limit window.
Default: 0
rate_limit_remainingRemaining requests in the current hourly rate limit window.
Default: 0
rate_limit_usage_percentPercent of the hourly rate limit consumed (0-100).
Default: 0
APIKeyCreateRequest
Payload for creating a new API key.
nameLabel shown in dashboards, e.g. 'Internal Service'.
permissionsPermission scopes granted to the API key.
Optional expiration window in days (0 means never expires).
never_expiresIf true the API key stays active until revoked manually even if expires_in_days is omitted.
Default: true
Optional list of IPv4/IPv6 addresses allowed to use this key.
Override default hourly request cap for this key.
APIKeyOperationResponse
Generic response for destructive operations.
messagekey_idactive_countUserResponse
Response model for user information.
usernameemailfirst_namelast_namerequired
uuidPaginatedResponse
counttotal_pagespagepage_sizerequired
required
object[] · required
PricingPlanOut
idrequired
required
required
credits_amountduration_daysis_activeplan_typerequired
required
required
required
statusobject · required
required
created_atupdated_atNotificationSettingsResponse
email_notifications_enabledconversion_completeconversion_failedstorage_warningsmarketing_emails_enabledUserFileOut
Serialized representation of a user-managed file.
idfile_names3_keyfile_size_bytesstorage_bytes_recordedcreated_atupdated_atRegisterUserFileRequest
Register an existing S3 object as a user file.
s3_keystorage_already_trackedDefault: false
StorageUsageOut
Storage usage metadata.
limit_bytesused_bytesremaining_bytesprice_per_gb_centsUserFileListResponse
Paginated user files with storage metadata.
counttotal_pagespagepage_sizerequired
required
object · required
Storage usage metadata.
object[] · required
DownloadUserFileOut
Download details for a user-managed file.
idfile_namefile_size_bytesDownloadUserFilesRequest
Payload for downloading one or many user-managed files.
file_idsdownload_allDefault: false
DeleteUserFilesRequest
Payload for deleting one or many user-managed files.
file_idsremove_allDefault: false
BusinessOut
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
BusinessUpdate
required
required
required
required
required
required
required
required
required
required
required
required
required
required
BusinessVerification
Schema for business verification
is_verifiedobject[]
Default: []
BusinessUserOut
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
BusinessUserInvite
Schema for inviting users to a business
emailroleDefault: employee
is_primary_contactDefault: false
BusinessUserRoleUpdate
Schema for updating user roles within a business
user_idroleBusinessUserIn
Schema for creating business user relationships
user_idroleDefault: employee
is_primary_contactDefault: false
StructuredPricingPlanOut
idnamedescriptionpricecredits_amountbilling_cycleobject[] · required
plan_typepopularDefault: false
PaginationInfo
total_countlimitoffsethas_moreTransactionOut
transaction_idrequired
amountcreated_atpayment_methodstatusdescriptionobject · required
formatted_dateTaskCompletionResponse
Success response for task completion reporting.
successmessageremaining_creditsremaining_balance_usdCredit transaction primary key.
TaskCompletionRequest
Request payload for reporting task completion.
task_idUnique identifier for the task (idempotency key).
service_nameName of service reporting the task.
task_start_timeISO timestamp for when task started.
task_finish_timeISO timestamp for when task finished.
processing_time_secondsProcessing duration in seconds.
credit_costCredits consumed by the task.
Optional UUID of the end user. Used for validation but must match the authenticated user.
Categorization for the task (image_processing, etc.).
Optional file size in bytes.
Optional output format shorthand (pdf, jpg, ...).
Optional quality/preset string.
Optional S3 key for the generated output (for storage management).
Optional friendly name for the output file.
Optional content type for the output file.
TaskHistoryItem
Single task entry returned from task history endpoint.
required
service_namerequired
credits_usedprocessing_timecompleted_attask_idrequired
required
required
UsageSummaryCurrent
total_conversionssuccess_ratefailed_conversionsstorage_used_mbUsageSummaryDelta
total_conversions_pctsuccess_rate_pctfailed_conversions_diffstorage_used_pctUsageSummaryPrevious
total_conversionssuccess_ratefailed_conversionsstorage_used_mbRecentConversion
idinput_filenamesource_formattarget_formatinput_size_bytesrequired
created_atstatusstatus_labelstatus_colorrequired
ConversionDetailResponse
iduser_idinput_filenamesource_formattarget_formatinput_size_bytesrequired
statusrequired
required
created_atrequired
required
required
required
AppleOAuthInitResponse
Response schema for Apple OAuth initiation.
authorization_urlmessageGoogleOAuthInitResponse
Response schema for Google OAuth2 initiation.
authorization_urlmessageSocialErrorResponse
Response schema for social authentication errors.
errordetailsMFAStatusResponse
Response schema for MFA status.
is_enabledmethodstotp_enabledsms_enabledemail_enabledbackup_codes_countsecurity_scoreTOTPSetupResponse
Response schema for TOTP setup.
secret_keyqr_code_urlmanual_entry_keybackup_codesSMSVerificationResponse
Response schema for SMS verification.
phone_numberverification_sentexpires_inEmailVerificationResponse
Response schema for email verification.
emailverification_sentexpires_inMFAChallengeResponse
Response schema for MFA challenge.
challenge_idmethods_availableexpires_inmessageMFAVerificationResponse
Response schema for successful MFA verification.
successmessageaccess_tokenrefresh_tokenexpires_intoken_typeDefault: Bearer
MFADisableRequest
Request schema for disabling MFA.
methodverification_codeBackupCodesResponse
Response schema for backup codes.
codesgenerated_atexpires_atremaining_codesMFADeviceListResponse
Response schema for listing MFA devices.
object[] · required
total_countactive_countMFADeviceResponse
Response schema for MFA devices.
idmethodnameis_activecreated_atMFASecurityResponse
Response schema for MFA security information.
total_attemptssuccessful_attemptsfailed_attemptsblocked_attemptstrusted_devicessecurity_scorerecommendationsDefault: []
DropboxAuthorizeOut
Schema for Dropbox authorization response.
authorization_urlmessageDropboxDisconnectOut
Schema for Dropbox disconnect response.
successmessageDropboxContentsOut
Schema for Dropbox contents listing.
pathobject[] · required
has_moreDropboxFileInfo
Schema for Dropbox file/folder information.
namepathtypeBoxAuthorizeOut
Schema for Box authorization response.
authorization_urlmessageBoxDisconnectOut
Schema for Box disconnect response.
successmessageBoxContentsOut
Schema for Box contents listing.
pathobject[] · required
total_countoffsetlimitBoxFileInfo
Schema for Box file/folder information.
namepathtypeOneDriveAuthorizeOut
Schema for OneDrive authorization response.
authorization_urlmessageOneDriveDisconnectOut
Schema for OneDrive disconnect response.
successmessage