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

# Understand the API

> Learn what the NoimosAI API does, how execution works, and how it relates to Developer Platform.

## Overview

The API lets you embed NoimosAI search, analysis, and generation in your own services or business systems. This page explains suitable use cases, the execution flow, and the relationship with Developer Platform.

> [!NOTE]
>
> The API is for projects with API access enabled in Developer Platform. API keys, permissions, usage history, and billing balances are separate from regular NoimosAI workspaces.

## When to use the API

Use the API to repeat operations under predefined conditions or call NoimosAI from your own interface. Examples include:

* Add search or content generation to your service.
* Run analysis regularly from internal systems.
* Process multiple inputs in your own sequence.
* Record execution results and charges in your systems.

Use the [CLI](https://docs.noimosai.com/developers/cli/overview.md) for direct terminal access, or the [MCP server](https://docs.noimosai.com/developers/mcp/overview.md) for conversations in an AI client. See [Developer tools](https://docs.noimosai.com/developers/overview.md) for differences in authentication and billing.

## Understand the execution flow

Some operations vary in price with the input or model. Obtain a free quote and review the maximum charge before starting paid work. You do not need to keep a connection open until completion: use the execution ID returned on acceptance to track progress.

The basic flow has five steps:

1. Check the tool and its required inputs.
2. Get a free estimate of the maximum charge for your input before starting work.
3. Execute the same quoted request with the reviewed spending cap.
4. Use the execution ID returned on acceptance to poll until completion.
5. Retrieve the result and settled charge. Download any generated files from expiring URLs.

See [Get started](https://docs.noimosai.com/developers/api/getting-started.md) for endpoints and sample requests. The Developer Platform [Documentation](https://platform.noimosai.com/docs) also describes the current quote and execution flow.

## Understand Developer Platform

Each API key is bound to one Developer Platform project. Project permissions apply to executions created with that key, usage history, and the prepaid USD balance.

The API runs stateless tools. It does not automatically use brand information or connected accounts saved in regular NoimosAI workspaces. Include required text, public URLs, and public account identifiers in your requests.

## Check tools and pricing

Available tools, input fields, models, availability, and prices can change. Read `GET /tools` and `POST /tools/quote` at runtime instead of hardcoding lists or prices.

## Related pages

Use these pages to get started and review the specifications.

* [Get started](https://docs.noimosai.com/developers/api/getting-started.md)
* [Authenticate requests](https://docs.noimosai.com/developers/api/authentication.md)
* [Manage execution and billing](https://docs.noimosai.com/developers/api/execution-and-billing.md)
* [API reference](https://docs.noimosai.com/developers/api/reference.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.