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

# Overview

> The ZylonGPT API lets you generate responses, ingest knowledge, create embeddings, and call tools in one flow.

<Warning>
  **Upcoming release — Zylon 1.58**

  These docs are published ahead of release so you can prepare your API integrations. The release image is not yet available. For installations running 1.57, use the [1.57 documentation](/en/v1.57/overview).
</Warning>

ZylonGPT is the model-facing API. Most apps follow a simple loop: send messages, attach or reference artifacts, generate embeddings for search, and let the assistant call tools when it needs structured data or retrieval.

## Authentication and scopes

Use a gateway-scoped token from [Developer Console](/en/v1.58/developer-manual/get-started/developer-console). `PrivateGPT.Read.All` allows the endpoints below. An account token with `Read.All` reaches the same allowlist only when it carries gateway context through `gateway_id`; `Read.All` can be created without `gateway_id`, but that token cannot call ZylonGPT.

* `POST /api/gpt/v1/messages`
* `POST /api/gpt/v1/complete`
* `POST /api/gpt/v1/messages/count_tokens`
* `POST /api/gpt/v1/messages/validate`
* `POST /api/gpt/v1/embeddings`
* `GET` and `HEAD` requests under `/api/gpt/v1/skills`
* `POST /api/gpt/v1/skills/validate`

Async message lifecycle routes, every artifact route, skill mutations, and unmatched fallback routes require a read-write scope and return `403` for a read-only token. Use `PrivateGPT.ReadWrite.All` for a gateway-scoped token or `ReadWrite.All` where account-token access is appropriate. Multiple scopes combine their grants, but effective permissions remain limited by the token owner's roles. See [Token Management](/en/v1.58/developer-manual/get-started/token-management) for creation defaults and validation rules.

<CardGroup cols={2}>
  <Card title="Messages" icon="message" href="/en/v1.58/developer-manual/build-with-zylon/working-with-messages">
    Send synchronous messages with read access; async lifecycle operations require read-write access.
  </Card>

  <Card title="Artifacts" icon="file" href="/en/v1.58/developer-manual/build-with-zylon/working-with-artifacts">
    Ingest, retrieve, list, or delete collection content with read-write access.
  </Card>

  <Card title="Embeddings" icon="database" href="/en/v1.58/developer-manual/build-with-zylon/zylon-gpt-api/embeddings">
    Turn text into vectors for search and similarity.
  </Card>

  <Card title="Tools API" icon="toolbox" href="/en/v1.58/developer-manual/build-with-zylon/tools/introduction-to-tools">
    Enable semantic search, tabular analysis, web fetch, and custom tools.
  </Card>
</CardGroup>


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