You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/api.nameai.dev/README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,16 @@
3
3
## API
4
4
The API extends the NameGuard API and is fully compatible with it.
5
5
6
-
NameAI-specific endpoints are under the [api.nameai.dev](https://api.nameai.dev) path prefix and
7
-
NameGuard-specific endpoints are under the [api.nameai.dev/nameguard](https://api.nameai.dev/nameguard) path prefix.
6
+
NameAI-specific endpoints are under the `https://api.nameai.dev` path prefix and
7
+
NameGuard-specific endpoints are under the `https://api.nameai.dev/nameguard` path prefix.
8
8
9
9
API documentation is available at [api.nameai.dev/docs](https://api.nameai.dev/docs) for NameAI and [api.nameai.dev/nameguard/docs](https://api.nameai.dev/nameguard/docs) for NameGuard.
10
10
11
11
Lambda is publicly accessible under given domain [api.nameai.dev](https://api.nameai.dev)
12
12
13
+
## SDK
14
+
The NameAI SDK provides a convenient way to interact with the NameAI API in your JavaScript/TypeScript applications. You can find the SDK implementation and documentation at [github.com/namehash/namekit/tree/main/packages/nameai-sdk](https://github.com/namehash/namekit/tree/main/packages/nameai-sdk).
15
+
13
16
# AWS deploy
14
17
## Requirements
15
18
- Poetry - Python package management
@@ -116,3 +119,13 @@ This script can be run manually with `poetry run python -m nameai.generate_stati
116
119
Static data is generated once and stored in `nameai/data/static` directory.
117
120
118
121
Static data is used to speed up NameAI API calls by storing precomputed results in pickle files.
122
+
123
+
## Contact Us
124
+
125
+
Visit our [website](https://namehashlabs.org/) to get in contact.
[NameAI](https://nameai.dev) extends [NameGuard](https://nameguard.io) with sophisticated natural language processing capabilities to help evaluate and understand Ethereum Name Service (ENS) names.
6
6
7
7
[NameGuard](https://nameguard.io) is designed to inspect and prevent malicious use of ENS names by providing comprehensive security checks. See the [NameGuard SDK documentation](../nameguard-sdk/README.md) for details about the base security features.
8
8
9
9
⚠️ **This SDK is BETA. Things will change based on the community feedback.**
10
10
11
+
## Implementation
12
+
13
+
This SDK provides a TypeScript interface to the NameAI API. Developers interested in the API internals can find the implementation in the [NameAI backend service](https://github.com/namehash/namekit/tree/main/apps/api.nameai.dev).
14
+
11
15
## Features
12
16
13
17
Additional features provided by NameAI on top of NameGuard:
0 commit comments