> For the complete documentation index, see [llms.txt](https://nuderebatsin-roal.gitbook.io/zkcloud-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nuderebatsin-roal.gitbook.io/zkcloud-docs/apis/introduction.md).

# Introduction

### Introduction

The zkcloud api is build on HTTP. Our API is RESTful Api.

### BaseURL

All API calls referenced in our documentation start with a base URL.It’s also important to note that our platform uses URI versioning for our API endpoints, 

Our base URL is:

```bash
https://api.zkcloud.systems/
```

### Authentication

The zkcloud api use API Keys to authenticate all requests. You can view and manage your API Keys in [the settings page](https://zkcloud.systems/settings/).

Please keep it in a safe place so that it will not be published. If you don't need to use api keys, delete the api keys in the settings paes.

Authentication to the API is performed via bearer auth. use `-H` .

To test requests using your account, replace the `<API_TOKEN>` with your actual API key.

```bash
curl -H "Authorization: Bearer <API_TOKEN>"
```

### Versioning

We adopt media Type Versioning uses the `Accept` header of the request to specify the version. You add `v=1` on the headers to request all apis.

```bash
curl -H "Accept: application/json;v=1" -H "Authorization: Bearer <API_TOKEN>" http://localhost:4000/proofs
```

### Date Format

JSON does not have a built-in date type, dates are passed as strings encoded according to [**RFC 2822#page-14**](https://tools.ietf.org/html/rfc2822.html#page-14).&#x20;

```bash
'Sun, 03 Oct 2021 14:02:46 GMT'
```

### Status Codes

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.

| StatusCode                         | Description                                                                                                                                               |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200 - OK                           | API works well.                                                                                                                                           |
| 204 - No Content                   | No Content indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
| 401 - Unauthorized                 | Unauthorized Error is an HTTP response status code indicating that **t**he request sent by the client could not be authenticated.                         |
| 403 - Forbidden                    | Forbidden error is meaning access to the requested resource is forbidden.                                                                                 |
| 404 - Not Found                    | The server can not find the requested resource.                                                                                                           |
| 429 - Too Many Requests            | The user has sent too many requests in a given amount of time.                                                                                            |
| 500, 502, 503, 504 - Server Errors | The server has encountered a situation it doesn't know how to handle.                                                                                     |

### Error Response

Error Reponse format is following.

```bash
{
  "error": {
    "message":"invalid token",
    "type":"invalid_request_error"
   }
}
```

Error type means the type of errors in the server. Message means actual error message.

| ErrorType               | Description                                                                     |
| ----------------------- | ------------------------------------------------------------------------------- |
| api\_error              | API Error message, it means something went wrong with the API request.          |
| invalid\_request\_error | Represents a validation error when users do not respond to mandatory questions. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://nuderebatsin-roal.gitbook.io/zkcloud-docs/apis/introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.