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

# api

> Make an authenticated request to an Entire API and print the response.

Make an authenticated HTTP request to an Entire API and print the JSON response.

```bash theme={null}
entire api PATH [flags]
```

Entire selects the backend host and supplies the bearer token automatically.

<Warning>
  These internal endpoints may change without notice. Prefer dedicated CLI commands such as [`entire activity`](/cli-reference/activity), [`entire search`](/cli-reference/search), and [`entire repo`](/cli-reference/repo) when available.
</Warning>

## Choose a Backend

| Value       | Backend                                                                            |
| ----------- | ---------------------------------------------------------------------------------- |
| `--to core` | The control plane. This is the default: orgs, repos, mirrors, clusters, and `/me`. |
| `--to cell` | Your home `entire-api` cell: `/me/*` activity and repository aggregates.           |

Use `--jurisdiction SLUG` to reach a specific jurisdiction's cell instead of your home one. It implies `--to cell`. Find your home jurisdiction with [`entire auth status`](/cli-reference/auth#auth-status).

## Path Placeholders

`PATH` is the full path on the chosen host, such as `/api/v1/clusters`. These placeholders are filled from the current repository's `origin` remote:

| Placeholder | Value                                                             |
| ----------- | ----------------------------------------------------------------- |
| `{owner}`   | The GitHub owner                                                  |
| `{repo}`    | The GitHub repository name                                        |
| `{repo_id}` | The repository's Entire ULID, from its mirror. Cells key on this. |

## Flags

| Flag                        | Description                                                                                                  |
| --------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `-F, --field KEY=VALUE`     | Add a typed parameter. `true`, `false`, `null`, and numbers are converted. Repeatable.                       |
| `-H, --header KEY:VALUE`    | Add a request header. Repeatable.                                                                            |
| `-i, --include`             | Print the response status line and headers too.                                                              |
| `--input FILE`              | File containing the request body. Use `-` for standard input.                                                |
| `-j, --jurisdiction SLUG`   | Target a specific jurisdiction's cell, such as `us` or `eu`, instead of your home cell. Implies `--to cell`. |
| `-X, --method METHOD`       | HTTP method. Defaults to `GET`, or `POST` when a field or body is given.                                     |
| `-f, --raw-field KEY=VALUE` | Add a string parameter, with no type conversion. Repeatable.                                                 |
| `--to BACKEND`              | Which backend to call: `core` or `cell`. Defaults to `core`.                                                 |

## Examples

```bash theme={null}
# Control plane
entire api /api/v1/clusters

# Your home cell
entire api --to cell /api/v1/me/activity

# A specific jurisdiction's cell
entire api --jurisdiction eu /api/v1/me/activity

# Fill the current repository's ULID into the path
entire api --to cell "/api/v1/me/recap?repo={repo_id}"

# POST with a string field
entire api -X POST /api/v1/projects -f name=demo
```

## Continue With

<CardGroup cols={2}>
  <Card title="auth token" icon="key" href="/cli-reference/auth#auth-token">
    Get the bearer token itself, for use with `curl`.
  </Card>

  <Card title="repo" icon="database" href="/cli-reference/repo">
    Use the purpose-built commands where they exist.
  </Card>
</CardGroup>