> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yir.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Yir asynchronous AI gateway

> Start building source-compatible, asynchronous image generation workflows with Yir.

Yir is an asynchronous-first AI gateway for long-running generation tasks. It gives your application a stable task ID, explicit status polling, and a consistent billing record while Yir manages certified provider routes.

The current developer preview is intentionally narrow: GPT Image 2 text-to-image through the certified KIE-compatible and APIMart-compatible routes. It is not the complete Yir v1 release. Video, music, 3D, arbitrary provider paths, and a general-purpose low-latency LLM proxy are not part of this preview contract.

## Start here

1. [Create and protect a Yir API key](/getting-started/authentication).
2. [Submit and query your first task](/getting-started/quickstart).
3. Follow the [production integration guide](/guides/production-integration).
4. Learn the [task lifecycle](/concepts/task-lifecycle) and [billing model](/concepts/billing).

## Two source-compatible surfaces

Choose the request and response shape your integration already understands:

* **KIE-compatible** — submit with `POST /kie/api/v1/jobs/createTask`, then query with `GET /kie/api/v1/jobs/recordInfo`.
* **APIMart-compatible** — submit with `POST /apimart/v1/images/generations`, then query with `GET /apimart/v1/tasks/{id}`.

Both surfaces use the same host and the same Yir API key:

```text theme={null}
https://gateway.yir.ai
```

Yir does not accept an upstream provider credential from your request. Provider credentials are managed inside Yir and never belong in client code, request bodies, or query parameters.