Ai | Notploy Documentation

Ai one

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

aiId*string

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.one?aiId=string"

curl -X GET "https://your-notploy-instance.com/api/ai.one?aiId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai get Models

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

apiUrl?string

apiKey?string

aiId?string

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.getModels"

curl -X GET "https://your-notploy-instance.com/api/ai.getModels"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai create

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

name*string

Length1 <= length

apiUrl*string

Formaturi

apiKey*string

model*string

Length1 <= length

isEnabled*boolean

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.create" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "apiUrl": "http://example.com",
    "apiKey": "string",
    "model": "string",
    "isEnabled": true
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "apiUrl": "http://example.com",    "apiKey": "string",    "model": "string",    "isEnabled": true  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai update

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

aiId*string

Length1 <= length

name?string

Length1 <= length

apiUrl?string

Formaturi

apiKey?string

model?string

Length1 <= length

isEnabled?boolean

createdAt?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.update" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.update" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai get All

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.getAll"

curl -X GET "https://your-notploy-instance.com/api/ai.getAll"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai get

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

aiId*string

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.get?aiId=string"

curl -X GET "https://your-notploy-instance.com/api/ai.get?aiId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai delete

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

aiId*string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.delete" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.delete" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai get Custom Providers

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.getCustomProviders"

curl -X GET "https://your-notploy-instance.com/api/ai.getCustomProviders"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai save Custom Providers

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

providers*

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.saveCustomProviders" \
  -H "Content-Type: application/json" \
  -d '{
    "providers": [
      {
        "name": "string",
        "apiUrl": "http://example.com"
      }
    ]
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.saveCustomProviders" \  -H "Content-Type: application/json" \  -d '{    "providers": [      {        "name": "string",        "apiUrl": "http://example.com"      }    ]  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai get Enabled Providers

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/ai.getEnabledProviders"

curl -X GET "https://your-notploy-instance.com/api/ai.getEnabledProviders"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai analyze Logs

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

aiId*string

Length1 <= length

logs*string

Length1 <= length

context*string

Value in"build" | "runtime"

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.analyzeLogs" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string",
    "logs": "string",
    "context": "build"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.analyzeLogs" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string",    "logs": "string",    "context": "build"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai test Connection

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

aiId?string

apiUrl?string

apiKey?string

model*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.testConnection" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.testConnection" \  -H "Content-Type: application/json" \  -d '{    "model": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai suggest

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

aiId*string

input*string

serverId?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.suggest" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string",
    "input": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.suggest" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string",    "input": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai deploy

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

environmentId*string

Length1 <= length

id*string

Length1 <= length

dockerCompose*string

Length1 <= length

envVariables*string

serverId?string

name*string

Length1 <= length

description*string

domains?

configFiles?

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/ai.deploy" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "string",
    "id": "string",
    "dockerCompose": "string",
    "envVariables": "string",
    "name": "string",
    "description": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/ai.deploy" \  -H "Content-Type: application/json" \  -d '{    "environmentId": "string",    "id": "string",    "dockerCompose": "string",    "envVariables": "string",    "name": "string",    "description": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Ai

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`