Skip to content

Orbifold AI Platform (1.0.0)

Centralized API Gateway documentation for Orbifold AI. This specification aggregates individual microservice definitions.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://platform.orbifold.ai/_mock/openapi/
Production Gateway
https://api.orbifold.ai/

Edit an image using a text prompt

Request

Sends text and images to for processing/editing.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
textstringrequired

The prompt text

Example: "Describe this image"
imagesArray of strings or objects

List of images to process

image_mimeTypestring

Default MIME type for images if not specified per image

Default "application/octet-stream"
response_modalitiesArray of strings

Desired response modalities

Default ["TEXT"]
temperaturenumber

Controls the randomness of the output

top_pnumber

Nucleus sampling parameter

top_kinteger

Top-k sampling parameter

max_output_tokensinteger

Maximum number of tokens to generate

system_instructionstring

System instructions for the model

curl -i -X POST \
  https://platform.orbifold.ai/_mock/openapi/edit-image \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "text": "Describe this image",
    "images": [
      "string"
    ],
    "image_mimeType": "application/octet-stream",
    "response_modalities": [
      "TEXT"
    ],
    "temperature": 0,
    "top_p": 0,
    "top_k": 0,
    "max_output_tokens": 0,
    "system_instruction": "string"
  }'

Responses

Successful response

Bodyapplication/json
okboolean
Example: true
base64_imagesArray of objects
Response
application/json
{
  "ok": true,
  "base64_images": [
    { … }
  ]
}