X Image Splitter logoX Image Splitter
X Image Splitter logoX Image Splitter

Developers

Developer Overview

The ways to build on %APP_NAME%: the REST API, MCP for AI agents, OAuth for apps, webhooks and machine-readable discovery.

Everything you can do on the website with an account (generating images with Seedream 5.5, improving prompts, managing Creations, checking Credits, starting a Credit Pack purchase, writing to support) is also available to your own code and to AI agents, with the same rules and the same prices. The Image Splitter runs only in the browser; integrations get a link that opens a generated image in it.

Integration surfaces

SurfaceUse it forAuthentication
REST APIScripts, backend services, and automationsAPI Key or OAuth token
MCPAI Agents and assistants connecting via MCPOAuth token
OAuthConnected Apps acting on behalf of usersAuthorization code + PKCE
WebhooksAsynchronous event delivery (generation completion, payment)Signed HTTP deliveries
DiscoveryMachine-readable inspection of product capabilities and catalogNone

All integration surfaces derive from a single Integration Action registry, guaranteeing feature parity between REST API operations, MCP tools, and OpenAPI definitions.

Choose a credential

  • Direct scripts and backends: access the REST API with an API Key provisioned in account settings.
  • Third-party applications and AI Agents: authenticate via OAuth 2.1, requesting delegated user consent for designated Scopes.

Both credential types carry Scopes, such as generations:write or credits:read. Each operation enforces a specific Scope; credentials lacking it return 403 Forbidden (insufficient_scope).

A typical generation flow

  1. GET /models to list models, their operations, options and limits.
  2. POST /generations/estimate to see the price in Credits.
  3. POST /uploads and a PUT of the file, if you want to add reference images (free, up to 10).
  4. POST /generations to start the job. It returns a creationId immediately.
  5. Wait for the generation.completed webhook, or poll GET /generations/{creationId} until status is succeeded or failed.
  6. Give the user a splitterLinks URL from the response to split the image in their browser.

The REST API Reference walks through this flow with full examples.

Financial boundaries and human hand-offs

Agents and API clients can start a Credit Pack checkout, but cannot pay. The checkout returns a URL the user opens to pay. Subscriptions are no longer sold; changes to an existing subscription also return a confirmation URL. Admin capabilities are never exposed via public APIs.

Discovery documents

These public documents describe the product to tools and crawlers, and need no credential:

  • https://ximagesplitter.com/api/v1/openapi.json: the OpenAPI 3.1 document of the REST API.
  • https://ximagesplitter.com/.well-known/product-profile.json: the model, Credit Pack prices, generation costs and links in one JSON document.
  • https://ximagesplitter.com/llms.txt and https://ximagesplitter.com/llms-full.txt: these docs for language models.
  • Every docs page as Markdown: add .md to its address, or use Copy Markdown at the top of the page.