# Yir Documentation

> Build source-compatible asynchronous image generation workflows with Yir.

## Docs

- [Yir asynchronous AI gateway](https://docs.yir.ai/index.md): Start building source-compatible, asynchronous image generation workflows with Yir.
- [Authentication](https://docs.yir.ai/getting-started/authentication.md): Create a Yir API key and authenticate every Gateway request with a Bearer header.
- [Quickstart](https://docs.yir.ai/getting-started/quickstart.md): Submit and query a GPT Image 2 text-to-image task through either certified source-compatible route.
- [Production integration](https://docs.yir.ai/guides/production-integration.md): Build a resilient Yir client with idempotent submission, bounded polling, safe retries, and explicit failure handling.
- [Task lifecycle](https://docs.yir.ai/concepts/task-lifecycle.md): Understand asynchronous task IDs, polling, terminal states, progress, and late provider outcomes.
- [Credits and billing](https://docs.yir.ai/concepts/billing.md): Understand credit reservation, settlement, release, usage history, and reconciliation.
- [Submit a KIE-compatible GPT Image 2 text-to-image task](https://docs.yir.ai/api-reference/kie-gpt-image-2/submit-a-kie-compatible-gpt-image-2-text-to-image-task.md)
- [Get a KIE-compatible task](https://docs.yir.ai/api-reference/kie-gpt-image-2/get-a-kie-compatible-task.md)
- [Submit an APIMart-compatible GPT Image 2 text-to-image task](https://docs.yir.ai/api-reference/apimart-gpt-image-2/submit-an-apimart-compatible-gpt-image-2-text-to-image-task.md)
- [Get an APIMart-compatible task](https://docs.yir.ai/api-reference/apimart-gpt-image-2/get-an-apimart-compatible-task.md)
- [Troubleshooting and support boundaries](https://docs.yir.ai/support/troubleshooting.md): Diagnose authentication, admission, polling, and terminal task issues without exposing secrets.

## OpenAPI Specs

- [gateway-openapi](https://docs.yir.ai/openapi/gateway-openapi.json)