Apps

An app is a name for a stream of traffic. Register one and its requests are grouped under that name in your usage; list it publicly and it also appears on the ai.ml rankings with its own page. Everything here is in the console under Apps. Owners, admins and members can register, edit and delete apps. Billing and viewer roles can read the list.

Register an app

1. Press Register app.
2. Enter a Name.
3. Optionally enter a Slug: the public identifier used in the app's address and badge, in lowercase letters, digits and hyphens. Leave it empty to have it made from the name. It cannot be changed after creation.
4. Choose a Category.
5. Optionally add a Website, a Logo URL and a Description.
6. Leave List publicly on the ai.ml rankings and app page cleared to keep the app private, or tick it to list it now.
7. Press Register app.

The app appears in the list with its App id.

Attribute traffic to an app

The app id is what ties a request to the app. Click the id in the list to copy it, then either:

• send it as metadata.app on each request; or
• set it as a key's default app, so every request with that key is attributed without changing the request. Choose it under Default app when you create the key or on the key's page; see API keys.

For each request, metadata.app is used first. Without it, the X-Title or HTTP-Referer header is used, as apps written for OpenRouter already send. Without those, the key's default app applies. If your organization has turned attribution off, no app is recorded at all.

List an app publicly

A new app is private: it names your traffic in your own usage and nowhere else. Nothing is public until you ask.

To list it, click the app's name, tick List publicly on the ai.ml rankings and app page, and press Save. The list then shows it as listed. A listed app:

• appears on the public rankings under its name, category and logo;
• gets a public page showing the models it uses and its recent token trend;
• gets a "Powered by ai.ml" badge you can embed on your own site. The embed snippet is on the app's public page.

Owners and admins of a listed app receive a weekly e-mail when its rank changes.

To take an app off the rankings, clear the tick box and save.

Edit or delete an app

Click an app's name to open it. You can change everything except the slug, then press Save.

To delete it, press Delete, type delete to confirm, and press Delete app. Traffic already attributed to it stays in your analytics under the raw id.

Related

• Usage to see spend by app.
• OAuth apps: how a registered app can ask its users for a key.
• API keys