Skip to main content
POST
Universal Ai

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Universal AI request body.

Model format: feature/subfeature/provider[/model]

Examples: - text/ai_detection/openai/gpt-4 - ocr/ocr/amazon - image/generation/google/imagen-3

The input dict contains feature-specific parameters that are validated at runtime based on the parsed feature/subfeature.

model
string
required

Model in format: feature/subfeature/provider[/model]

Examples:

"text/ai_detection/openai/gpt-4"

"ocr/ocr/amazon"

"image/generation/google/imagen-3"

input
Input · object
required

Feature-specific input parameters. Required fields depend on the feature/subfeature specified in provider. Examples:

  • text/ai_detection: {'text': 'content to analyze'}
  • text/embeddings: {'texts': ['text1', 'text2']}
  • ocr/ocr: {'file_id': 'abc123', 'language': 'en'}
  • image/generation: {'text': 'prompt', 'resolution': '1024x1024'}
  • translation/document_translation: {'file_id': 'abc123', 'target_language': 'fr'}
Examples:
provider_params
Provider Params · object | null

Provider-specific parameters

fallbacks
string[]

Fallback providers to try if the primary provider fails, in order. Accepted formats:

  • 'provider' or 'provider/model' (e.g. 'amazon', 'openai/gpt-4')
  • full model id (e.g 'text/moderation/google', 'image/generation/minimax/image-01')
Maximum array length: 3
show_original_response
boolean | null
default:false

Include raw provider response in the output

Response

Successful Response

Sync response from universal-ai endpoint.

Inherits all fields from base, with status restricted to success/fail.

status
enum<string>
required

Whether the request succeeded or failed

Available options:
success,
fail
cost
string
required

Cost in credits for this request

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
provider
string
required

Provider name that processed the request

feature
string
required

Feature category (e.g., text, ocr, image)

subfeature
string
required

Specific subfeature (e.g., ai_detection, sentiment)

output
any
required

Normalized output from the provider

error
Error · object | null

Error details from the provider (only present when status is 'fail')

original_response
any | null

Raw response from the provider (if show_original_response=true)