Dokploy

Ai

GET
/ai.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

aiId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/ai.one?aiId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/ai.getModels

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

apiUrl*string
Length1 <= length
apiKey*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/ai.getModels?apiUrl=string&apiKey=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/ai.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

name*string
Length1 <= length
apiUrl*string
Formaturi
apiKey*string
model*string
Length1 <= length
isEnabled*boolean
[key: string]?never

Response Body

application/json

application/json

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

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

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
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/ai.update" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/ai.getAll

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/ai.getAll"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/ai.get

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

aiId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/ai.get?aiId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/ai.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

aiId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/ai.delete" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/ai.suggest

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

aiId*string
input*string
serverId?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/ai.suggest" \  -H "Content-Type: application/json" \  -d '{    "aiId": "string",    "input": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/ai.deploy

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

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?
[key: string]?never

Response Body

application/json

application/json

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

Admin

Previous Page

Application

Next Page