> For the complete documentation index, see [llms.txt](https://docs.floral.fun/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.floral.fun/getting-started/base-url.md).

# Base URL and conventions

|                            |                                                                 |
| -------------------------- | --------------------------------------------------------------- |
| API base URL               | `https://api.floral.fun`                                        |
| Authorization endpoint     | `https://api.floral.fun/oauth/authorize`                        |
| Token endpoint             | `https://api.floral.fun/oauth/token`                            |
| Revocation endpoint        | `https://api.floral.fun/oauth/revoke`                           |
| Server metadata (RFC 8414) | `https://api.floral.fun/.well-known/oauth-authorization-server` |

## Credentials

You get these by [creating an application](/getting-started/create-application.md) in the Developer Portal.

## Testing

There's no separate sandbox yet. Test against the API above with your own Floral account, using a `http://localhost` or `http://127.0.0.1` redirect URL during development. Only people who approve your application can be linked, so testing doesn't touch anyone else's account.

## Conventions

* **Where to call from.** Confidential clients call from their server. Public clients can call `/oauth/token`, `/oauth/revoke` and `/v1` directly from a browser.
* **JSON** for requests and responses, except `/oauth/token` and `/oauth/revoke`, which also accept form encoding.
* **Timestamps** are UTC, in RFC 3339 format.
* **Request size.** Bodies are limited to 2 MB. Larger requests return `413`.
* **Caching.** `/v1` and token responses are sent with `Cache-Control: no-store`.
* **IDs** are strings with a type prefix: `usr_`, `post_`, `com_`. Store them whole and treat them as opaque. Usernames can change, so key your records on `id`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.floral.fun/getting-started/base-url.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.