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

# API Overview

> Introduction to the Docyard API

# API Reference

The Docyard API is a RESTful API for document distribution. This section documents all available endpoints.

## Base URL

```
https://api.docyard.io/v1
```

## Authentication

All endpoints require API key authentication:

```bash theme={null}
-H "X-API-Key: your_api_key"
-H "X-API-Secret: your_api_secret"
```

See [Authentication](/introduction/authentication) for details.

## Response Format

All responses return JSON:

```json theme={null}
{
  "data": { ... },
  "metadata": { ... }
}
```

## Error Format

Errors return appropriate HTTP status codes with structured responses:

```json theme={null}
{
  "error": "error_code",
  "message": "Human-readable message",
  "details": { ... },
  "request_id": "req-abc123xyz"
}
```

See [Errors](/introduction/errors) for details.

## API Sections

### Artifact Types

Templates that define document types and their lock requirements.

| Endpoint                                                | Description             |
| ------------------------------------------------------- | ----------------------- |
| [List Templates](/api-reference/artifact-types/list)    | Get available templates |
| [Create Template](/api-reference/artifact-types/create) | Create a new template   |
| [Get Template](/api-reference/artifact-types/get)       | Get template details    |
| [Update Template](/api-reference/artifact-types/update) | Update a draft template |
| [Delete Template](/api-reference/artifact-types/delete) | Delete a draft template |

### Admin

Admin endpoints for vetting templates and managing the platform.

| Endpoint                                                    | Description                   |
| ----------------------------------------------------------- | ----------------------------- |
| [List Pending Templates](/api-reference/admin/list-pending) | Get templates awaiting review |
| [Approve Template](/api-reference/admin/approve)            | Approve a template            |
| [Reject Template](/api-reference/admin/reject)              | Reject a template             |

### Uploads

Upload endpoints for distributors.

| Endpoint                                                       | Description                  |
| -------------------------------------------------------------- | ---------------------------- |
| \[List Uploads]\(/api-reference/upload endpoints/list)         | Get your upload endpoints    |
| \[Create Upload]\(/api-reference/upload endpoints/create)      | Create a new upload endpoint |
| \[Upload Artifact]\(/api-reference/upload endpoints/upload)    | Upload a single artifact     |
| \[Batch Upload]\(/api-reference/upload endpoints/batch-upload) | Upload multiple artifacts    |
| \[Rotate Keys]\(/api-reference/upload endpoints/rotate-keys)   | Rotate API keys              |

### Docks

Retrieval endpoints for collectors.

| Endpoint                                                | Description                   |
| ------------------------------------------------------- | ----------------------------- |
| [List Lock Types](/api-reference/docks/list-lock-types) | Discover available lock types |
| [Search](/api-reference/docks/search)                   | Search for artifacts          |
| [Retrieve](/api-reference/docks/retrieve)               | Retrieve a single artifact    |
| [Batch Retrieve](/api-reference/docks/batch-retrieve)   | Retrieve multiple artifacts   |
| [Async Retrieve](/api-reference/docks/async-retrieve)   | Start async retrieval job     |

### Artifacts

Manage uploaded artifacts.

| Endpoint                                           | Description          |
| -------------------------------------------------- | -------------------- |
| [Get Artifact](/api-reference/artifacts/get)       | Get artifact details |
| [Revoke Artifact](/api-reference/artifacts/revoke) | Revoke an artifact   |
| [List Artifacts](/api-reference/artifacts/list)    | List your artifacts  |

### Audit

Access audit logs.

| Endpoint                                            | Description                    |
| --------------------------------------------------- | ------------------------------ |
| [List Logs](/api-reference/audit/list-logs)         | Query audit logs               |
| [Get Entity Logs](/api-reference/audit/entity-logs) | Get logs for a specific entity |

## Rate Limits

| Category             | Limit                |
| -------------------- | -------------------- |
| General API          | 1000 requests/minute |
| Upload (distributor) | 100 requests/minute  |
| Search (collector)   | 300 requests/minute  |
| Retrieve (collector) | 100 requests/minute  |

## SDKs

Official SDKs coming soon:

* Node.js / TypeScript
* Python
* Go

## Postman Collection

Download our Postman collection to explore the API:

[Download Postman Collection](#)

***

## Next Steps

* **[Authentication](/introduction/authentication)** - Set up API keys
* **[Errors](/introduction/errors)** - Handle errors properly
* **[Quickstart](/introduction/quickstart)** - Get started in 5 minutes