> For the complete documentation index, see [llms.txt](https://ro-proxy.gitbook.io/integration/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ro-proxy.gitbook.io/integration/roproxy-integration-api/2.-obtaining-an-api-key.md).

# 2. Obtaining an API key

To mint your first API key you must authenticate as the owning user. There are two equivalent ways to do this against `POST /api/key`:

**a) HTTP Basic auth** (simplest for a one-off call):

```bash
curl -X POST https://integration-api.ro-proxy.com/api/key \
  -u "you@example.com:your-password" \
  -H "Content-Type: application/json" \
  -d '{"name":"My integration"}'
```

**b) Bearer access token** obtained from `POST /api/user/login` (out of scope for this document):

```bash
curl -X POST https://integration-api.ro-proxy.com/api/key \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"name":"My integration"}'
```

The response contains a `token` field — the API key itself:

```json
{
  "message": "success",
  "data": {
    "id": 12,
    "name": "My integration",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "created_at": "2026-05-20T10:30:00Z"
  }
}
```

> **The `token` value is returned only once, at creation time.** Store it in a secure secret store immediately. Subsequent `GET /api/key` calls only return metadata (id, name, created\_at) — never the token.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ro-proxy.gitbook.io/integration/roproxy-integration-api/2.-obtaining-an-api-key.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.