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

# Revilico REST API reference: base URL and auth

> Base URL, bearer-token authentication and the OpenAPI 3.1 spec for the Revilico REST API, plus how to try each endpoint in the playground.

The REST API lets you run Revilico engines from your own code. New to it? Start with the [quickstart](https://docs.revilico.bio/developers/quickstart.md).

## Base URL

```text theme={null}
https://public-api.revilico.bio/v1
```

## Authentication

Send an [API key](https://docs.revilico.bio/developers/authentication.md) as a bearer token on every request except the health checks:

```bash theme={null}
curl https://public-api.revilico.bio/v1/me \
  -H "Authorization: Bearer rvl_live_…"
```

To try an endpoint in the playground on these pages, paste your key into the **Authorization** field. The requests are real: starting a run spends credits.

## Endpoints

| Area | What it covers |
| - | - |
| Account | Your account, credit balance and usage |
| Engines | The engines you can run, their parameter schemas and examples |
| Files | Uploading input files |
| Runs | Starting, following and cancelling runs of any engine |
| Results and outputs | Results as JSON, a run's files and its downloadable outputs |
| Projects | Grouping runs into projects |
| Engine runs | Starting a run of one engine, with that engine's parameters and input files |
| Health | Service status |

## OpenAPI spec

The API is described by an OpenAPI 3.1 spec. Use it to generate a client or import the API into a tool such as Postman:

```text theme={null}
https://public-api.revilico.bio/v1/openapi.json
```


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