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

# Introduction

> Overview of Enginy public API authentication, scopes, and available endpoint groups

## Welcome

Welcome to the Enginy API Reference. This section documents the public Enginy API surface, its authentication model, and the supported endpoint groups for external integrations.

The API reference includes endpoint groups for campaigns, tasks, contacts, companies, actions, webhooks, and inbox operations.

<Info>
  The interactive <b>Endpoints</b> section is generated from{' '}
  <code>[https://openapi.enginy.ai/definitions.json](https://openapi.enginy.ai/definitions.json)</code>. It reflects the public routes registered in the
  separate <code>openapi</code> service, not every internal Enginy route.
</Info>

<Card title="API Dashboard" icon="key" href="https://app.enginy.ai/api-access">
  Create an API Key or view call logs
</Card>

## Authentication

All API endpoints require authentication using an API key. Your API key must be included in the request header `x-api-key` for every API call.

### API Key Format

API keys follow a standardized format and begin with the prefix `gsk_`. You can generate and manage your API keys through the api dashboard.

```bash theme={null}
x-api-key: gsk_your_api_key_here
```

### API Key Management

API Keys can be managed through the API Dashboard. Keys can be revoked or assigned/removed scopes.

## Scopes and Permissions

API keys are assigned specific scopes that determine their access level and permissions. Each key must have at least one scope to function properly.

<Warning>
  API keys without assigned scopes will not have any permissions and all requests will be denied.
</Warning>

### Available Scopes

<AccordionGroup>
  <Accordion title="ALL" icon="unlock">
    Grants full access to all API endpoints and operations. This scope provides unrestricted access to your
    account resources.
  </Accordion>

  <Accordion title="IDENTITIES_READ" icon="eye">
    Provides read-only access to identity-related endpoints. Keys with this scope can retrieve identity data but
    cannot create, update, or delete records.
  </Accordion>

  <Accordion title="CAMPAIGNS_WRITE" icon="pen">
    Allows campaign mutations such as creating campaign drafts, adding contacts to campaigns, cloning campaigns,
    and changing campaign status.
  </Accordion>

  <Accordion title="OWNERS_READ" icon="users">
    Allows reading CRM owners for task assignment workflows through <code>GET /v1/tasks/owners</code>.
  </Accordion>
</AccordionGroup>

<Tip>
  For security best practices, we recommend using the most restrictive scope necessary for your use case.
  Avoid using the `ALL` scope unless your integration requires full account access.
</Tip>

<Info>
  Each endpoint description includes its exact required scope. Use those per-endpoint requirements for the
  source of truth when composing least-privilege API keys.
</Info>