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

# Verbosec API Reference for Developers

> The Verbosec REST API gives developers programmatic access to Nexus AI and Starhost. All endpoints use JSON over HTTPS with Bearer token authentication.

The Verbosec API is a REST API that gives you programmatic access to the full Verbosec platform — from generating AI-powered text, images, and voice content through Nexus AI, to managing site deployments and custom domains through Starhost. Every request is made over HTTPS and all request and response bodies use JSON.

<Info>
  **Base URL** — All API endpoints are relative to:

  ```
  https://api.verbosec.com/v1
  ```
</Info>

## What the API covers

Use the cards below to jump straight to any endpoint group.

<CardGroup cols={2}>
  <Card title="Text Generation" icon="pen-nib" href="/api-reference/nexus/text-generation">
    Generate articles, summaries, paraphrases, and more with Nexus AI.
  </Card>

  <Card title="Image Generation" icon="image" href="/api-reference/nexus/image-generation">
    Create photorealistic or illustrated images from text prompts.
  </Card>

  <Card title="Voice Generation" icon="microphone" href="/api-reference/nexus/voice-generation">
    Convert text to natural-sounding speech and download audio files.
  </Card>

  <Card title="File Chat" icon="file" href="/api-reference/nexus/file-chat">
    Upload documents and ask questions about their content.
  </Card>

  <Card title="Deployments" icon="rocket" href="/api-reference/starhost/deployments">
    Create, monitor, and roll back Starhost site deployments.
  </Card>

  <Card title="Domains" icon="globe" href="/api-reference/starhost/domains">
    Add custom domains to your sites and verify DNS records.
  </Card>
</CardGroup>

## Getting your API key

Every request to the Verbosec API must include a valid API key. You generate your key from the Verbosec Cloud dashboard and pass it as a Bearer token in the `Authorization` header on every request. See the [Authentication guide](/api-reference/authentication) for full instructions on generating a key and using it safely.

## Rate limits

Rate limits are enforced on a per-plan basis. If you exceed your plan's request quota, the API returns a `429 Too Many Requests` response. The response includes a `Retry-After` header indicating how many seconds you should wait before retrying. Upgrade your plan in the Verbosec Cloud dashboard if you consistently hit rate limits in production.

## Error responses

All API errors return a JSON body with a top-level `error` object containing a machine-readable `code` and a human-readable `message`. Use the `code` field in your application logic to handle specific error conditions programmatically.

```json error-response.json theme={null}
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}
```

<Accordion title="HTTP status code reference">
  | Status code                 | Meaning                                                                     |
  | --------------------------- | --------------------------------------------------------------------------- |
  | `200 OK`                    | The request succeeded and a response body is returned.                      |
  | `201 Created`               | A new resource was created successfully.                                    |
  | `400 Bad Request`           | The request body is invalid or a required parameter is missing.             |
  | `401 Unauthorized`          | Your API key is missing or invalid.                                         |
  | `403 Forbidden`             | Your API key is valid but does not have permission to access this resource. |
  | `429 Too Many Requests`     | You have exceeded your plan's rate limit.                                   |
  | `500 Internal Server Error` | An unexpected error occurred on the Verbosec servers.                       |
</Accordion>